Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
R
rdos-python
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Julien David
rdos-python
Merge requests
!3
Ajout de règles de contribution
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
Ajout de règles de contribution
add-contributing
into
master
Overview
0
Commits
1
Pipelines
0
Changes
1
Merged
Julien David
requested to merge
add-contributing
into
master
4 years ago
Overview
0
Commits
1
Pipelines
0
Changes
1
Expand
0
0
Merge request reports
Compare
master
master (base)
and
latest version
latest version
91eda573
1 commit,
4 years ago
1 file
+
36
−
0
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
CONTRIBUTING.md
0 → 100644
+
36
−
0
Options
# CONTRIBUTING
## Merge Request Process
-
Pour chaque tâche à effectuer, créer une nouvelle branche dont le nom indique
l'objectif de la nouvelle tâche.
-
Respecter les règles pour obtenir un code propre
-
chaque merge request doit être accompagnée de tests ajoutées dans le répertoire test.
-
Le nom du développeur et celui du relecteur de la merge request apparaissent dans l'entête
de chaque ficher de code.
## Tests unitaires
-
Le nom de chaque fichier doit commencer par
`test_`
-
Le nom de chaque fonction doit commencer par
`test_`
## Code Propre
-
Les commentaires précédents une fonction ne doivent pas être séparés de celle ci par des sauts de ligne
-
Une fonction doit avoir un nom explicite.
-
Le nom des variables globales suit la syntaxe suivante __RDOS_NOM__
-
Chaque fonction doit être commentée. Les commentaires de chaque fonction contiennent une explication sur les paramètres
de la fonction et sur les différentes valeurs de retour.
-
pour du code Python, on essaiera d'expliciter au maximum le type des paramètres de chaque fonction.
### Exemple
`def ma_fonction(x, chaine)`
n'est pas assez explicite.
`def ma_fonction(x:int, chaine: str)`
est préféré.
Loading