Ce guide a pour but de vous aider à contribuer à ce dépôt.
En addition, vous pouvez retrouver la documentation technique et les bonnes pratiques de rédaction dans le répertoire docs
.
Lors de la création d'un chapitre, il est important d'ajouter un exercice associé.
- Créez un fork du dépôt
- Ajoutez un nouveau fichier dans le répertoire
cours
(veuillez suivre la nomenclature) - Ajoutez le chapitre à la table des matières (
index.md
) - Ajoutez le ou les exercices associés dans le répertoire
exercices
(veuillez suivre la nomenclature) - Créez une pull request
- Précisez les améliorations apportées dans la description de la PR
- Associez votre PR à une issue (si elle existe)
- Créez un fork du dépôt
- Corrigez le chapitre concerné
- Créez une pull request
- Précisez les améliorations apportées dans la description de la PR
- Associez votre PR à une issue (si elle existe)
Si vous constatez un problème/une erreur dans un chapitre, vous pouvez le remonter en créant une issue. Pensez à vérifier si l'issue n'a pas déjà été remontée par vous ou un autre contributeur ou si une PR n'existe pas déjà.