Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 1.25 KB

Guide de contribution

Introduction

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.

Ajouter des chapitres

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)

Corriger des chapitres

  • 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)

Remonter un problème

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à.