Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (49 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

57 lines (49 loc) · 2.69 KB
Raw

Pour commencer

  1. Rejoindre la communauté Data For Good
  2. Sur le slack Data For Good, rejoindre le canal #13_potentiel_solaire et se présenter
  3. Remplir le formulaire
  4. Demander un accès en écriture si je souhaite proposer une modification du code
  5. Je regarde les issues ouvertes

Après avoir été affecté à une issue

  1. Cloner le projet en local :
    git clone https://github.com/dataforgoodfr/13_potentiel_solaire.git
  1. Si ca fait un moment que le projet a été cloné, s'assurer d'être à jour avec le code :
    git checkout main
    git pull origin main
  1. Créer une branche avec un nom qui facilitera le lien avec une tâche du projet :
    git checkout -b <branch-name>

Pattern à suivre pour le nom de la branche :

  • si ca concerne une exploration / poc :
    • pour les données de potentiel solaire : explore/data-<numero_issue>-<titre_exploration>
    • pour l'application web : explore/web-<numero_issue>-<titre_exploration>
  • si ca concerne l'ajout d'une nouvelle fonctionnalité :
    • pour les données de potentiel solaire : feature/data-<numero_issue>-<titre_fonctionnalite>
    • pour l'application web : feature/web-<numero_issue>-<titre_fonctionnalite>
  • si c'est pour corriger un bug :
    • pour les données de potentiel solaire : fix/data-<numero_issue>-<titre_du_bug>
    • pour l'application web : fix/web-<numero_issue>-<titre_du_bug>

Exemple : si c'est pour ajouter le calcul de l'orientation des toits de l'issue numéro 78, la branche s'appelle : feature/data-78-calcul_orientation_toits

  1. Je m'assigne sur l'issue pour que tout le monde soit au courant que je travail dessus

Pendant la réalisation de la tâche

  1. Essayer d'avoir des messages de commit le plus clairs possibles :
    git add script_modifie.py
    git commit -m "<description de la modification>"
  1. Ne jamais commit directement sur main !
  2. Si je n'ai plus le temps de terminer mon travail, je le notifie sur slack et je m'enleve des assignees sur l'issue

Une fois la tâche terminée

  1. Push sa branche :
    git push -u origin <branch-name>
  1. Créer une pull request sur github
  2. Demander une review et une validation de la PR pour qu'elle soit merge sur main
  3. Une liste de verifications pour faciliter la validation est disponible dans ce template
  4. Une fois la PR validée et merger sur main : je supprime ma branche et je cloture l'issue