update README for contributing

This commit is contained in:
Laetitia Getti 2023-06-01 15:10:01 +02:00
parent a272cd784f
commit 952a6460d6

View file

@ -4,6 +4,21 @@
La Chariotte est une application web sous licence libre Affera GPL, développée et maintenue par [Hashbang](https://hashbang.fr/).
## Contribuer
Si vous souhaitez contribuer au projet de la Chariotte, merci beaucoup !
Pour cela, une fois que vous avez cloné le projet et obtenu le statut de développeur sur le projet GitLab, vous pouvez :
- choisir une tâche dans le board que vous voulez réaliser, et vous l'assigner - si vous ne savez pas quelle tâche faire, n'hésitez pas à écrire à laetitia@chariotte.fr
- créer une nouvelle branche **à partir de develop** dont le nom dira ce que vous voulez faire
- réaliser la tâche, sans oublier d'écrire et de lancer les tests (voir plus bas)
- créer une Merge Request, contenant le plus de détails possible sur ce que vous avez fait
Ensuite, un maintainer de la Chariotte pourra relire votre code et proposer des améliorations/poser des questions si nécessaire. Seuls les maintainers peuvent merger dans develop et main.
Encore merci, et bon code !
## Développement
Cloner le projet :