Bonnes Pratiques de Configuration - MaximeDanlee/admin2-projet GitHub Wiki

Bonnes Pratiques

  • On décrit ce qui a changé lors des commits de façon a pouvoir les distinguer d’autres commits,
  • On évite de push des dossiers inutiles sur GitHub, tels que les venv Python, les fichiers .ini, etc. ,
  • On met régulièrement à jour les fichiers README.md,
  • On respect l’organisation des fichiers décidé lors du début de projet,
  • On effectue des commits réguliers de ce qu’on a écrit comme configuration,
  • On essaye de commenter nos configurations de façon à ce qu’ils soient clairs même pour quelqu’un qui les voit pour la première fois,
  • Avant de commit et push une configuration, toutes les autres fonctionalités fonctionnent toujours,
  • On accorde de l'attention aux détails de finition. Que ce soit au niveau de la mise en forme de configurations, du fonctionnement des différents services ou autre,
  • On évite d'écrire des messages de commits plus longs que 75 caractères,
  • On tient compte de l'orthographe dans les fichier de configuration et lors des commits,
  • On respecte le travail d'un autre memebre : on ne le suprimme pas et on ne fait pas de grosses modification sans qu'il le sache.