| createDate | lastUpdateDate | author | keywords |
|---|---|---|---|
2018-11-19 |
2019-03-08 |
marco46 |
Git, contribuer, opensource |
Le fichier README.md du dépôt doit être lu en intégralité et très attentivement. Par convention c'est le point d'entrée documentaire de tout projet.
Il est affiché par défaut par les outils web type GitHub / GitLab lorsqu'on accède au dépôt du projet.
Les premières instructions pour utiliser le projet (installation des dépendances, compilation, exécution, ...) sont souvent rédigées dans ce fichier.
Ces informations sont généralement reprises sur le wiki du projet et sur le site de présentation si il en dispose.
Certains projets ont d'autres fichiers servant à rentrer plus dans le détail, souvent au format markdown, qu'il est utile de lire. Parmi ces fichiers ont peut trouver :
CONTRIBUTE.mdouCONTRIBUTING.md, certains projets proposent un fichier dédié aux informations liées aux contributions.LICENSE.md, important de savoir quelle sera la licence de votre contribution.ISSUE_TEMPLATE.md, un template pour la création d'issue. Il est de bon ton de le respecter !PULL_REQUEST_TEMPLATE.md, un template pour la création des Pull Request. De même il est de bon ton de le respecter !CODE_OF_CONDUCT.md, un code de conduite à tenir dans vos échanges avec les autres contributeurs. Il est parfois nécessaire de l'accepter en même temps que la première Pull Request.CODING_STYLE.md, décrit ou donne des liens décrivant le style de code à utiliser. Ce fichier est parfois associé à un linter qui sera exécuté dans l'intégration continue avec les tests.