Browse Source

📖 update contribute

develop
tykayn 2 years ago
parent
commit
c4982267d2
  1. 22
      doc/CONTRIBUTE.md

22
doc/CONTRIBUTE.md

@ -4,12 +4,24 @@ Il existe des tas de façons de contribuer à un logiciel libre comme Framadate.
* Avoir un compte Framateam, et Framagit si vous souhaitez contribuer au code
* Examiner les tickets
Discuter avec les autres membres participant, sur un ticket en particulier et aussi dans les canaux de framateam
* Une fois d'accord avec les autres, mettre à jour votre dépot de travail local
* Utiliser la branche dev
* Faire une branche dédiée à vos modifications
`git checkout -b ma-description-de-fonctionnalite`
* Nous avons créé deux canaux: un pour les discussions générales, et un autre pour les discussions techniques de dev. Prenez soin de bien cibler le canal dans lequel vous communiquez afin de ne pas faire peur aux gens qui ne codent pas et qui souhaitent contribuer de toutes les autres façons.
* Une fois d'accord avec les autres, mettre à jour votre dépot de travail local. Voir [la doc d'installation / getting started](GETTING_STARTED.md) à ce sujet.
* Utiliser la branche `develop`
```
git checkout develop
git fetch
```
* choisir un ticket gitlab consacré à votre branche, si il n'en existe pas, le créer. Un ticket doit avoir un sujet suffisament petit pour pouvoir le réaliser dans un temps raisonnable. Faites des sous-tickets reliés pour les longues fonctionnalités. Le but des tickets n'étant pas de rester ad vitam dans la backlog, mais bien de montrer un avancement détaillé, avec un titre évocateur. "exit donc les tickets du genre 'ça ne marche pas' ou 'finir framadate'"
* Faire une branche dédiée à vos modifications en lui mettant un nom éloquent.
```
git checkout -b ma-description-de-fonctionnalite
```
* lisez les logs des commits les plus récents pour comprendre ce qui se passe.
* Faites des petits commits, avec un titre désignant précisément ce sur quoi vous progressez.
* Faire une merge request sur framagit qui sera soumise à la revue de code par les pairs du projet.
* Continuer à interagit avec les autres membres
* Continuer à interagir avec les autres membres pour utiliser au mieux les savoir-faire de chacun et ne pas se marcher sur les pieds.
* Mettez toujours en avant la politesse et l'empathie, la collaboration n'en sera que meilleure.
* N'hésitez pas à contacter en direct les personnes avec lesquelles vous souhaitez avancer.
# Qui veut faire quoi?

Loading…
Cancel
Save