Les contributions externes sont les bienvenues !
- Vérifiez que vous avez un compte Github.
- Forkez le dépôt.
- Vérifiez que vous avez la dernière version du repository.
- Attribuez-vous votre ticket (si vous fixez un ticket). C'est important pour éviter de se marcher dessus. Si vous n'êtes pas dans l'organisation et donc que vous ne pouvez pas vous attribuer directement le ticket, ajoutez simplement un commentaire clair dans celui-ci (tel que "Je prends").
- Créez une branche pour contenir votre travail.
- Faites vos modifications.
- Poussez votre travail et faites une pull request.
-
Le workflow Git utilisé est le suivant :
- Les PR sont unitaires. Aucune PR qui corrige plusieurs problèmes ou apporte plusieurs informations ne sera acceptée ; la règle est : une information ou une correction = une PR.
- Les PR sont mergées dans la branche
master, après une relecture légère. - Pensez à préfixer vos branches selon l'objet de votre PR :
typo-XXX,site-XXX,cnc-XXX, etc.
-
Faites des messages de commit clairs et en français.
- Lors de l'ouverture d'une PR, veuillez décrire ce que vous ajoutez / fixez.
-
Pour les commits, nous suivons le même ordre d'idée des standards Git, à savoir :
- La première ligne du commit ne doit pas faire plus de 50 caractères.
- Si besoin, complétez votre commit via des commentaires, en respectant une limite de 70 caractères par ligne.
- Le commit doit être de préférence en français.
- Vous pouvez également (c'est d'ailleurs conseillé) de référencer l'issue que vous fixez si vous en fixez une. Par exemple :
Fixe #789 - Un commit doit être atomique ; il fixe / ajoute une chose et le fait bien.
-
Essayez d'éviter les commits dits inutiles (
fix previous commit, ...). Si vous en avez dans votre pull-request, un squash sera effectué lors du merge.
N'hésitez pas à demander de l'aide, et bon courage !