mon-entreprise/CONTRIBUTION.md

1.1 KiB

Style du code

Nous utilisons Prettier. L'idéal est que chaque contributeur l'installe dans son éditeur de texte avec un formattage automatique à chaque CTRL-S.

De même, nous avons une configuration eslint, qui permet par exemple d'éviter de garder des variables inutilisées.

Messages de commit

A mettre sans retenue dans les messages de commit :

https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages

  • 🎨 :art: when working on the app's visual style
  • 🐎 :racehorse: when improving performance
  • 📝 :memo: when writing docs
  • 🐛 :bug: when fixing a bug
  • 🔥 :fire: when removing code or files
  • 💚 :green_heart: when fixing the CI build
  • :white_check_mark: when adding tests
  • ⬆️ :arrow_up: when upgrading dependencies
  • :sparkles: when formatting files

Et ceux spécifiques au projet :

  • ⚙️ :gear: pour une contribution au moteur qui traite les YAML
  • 🔨 :hammer: pour une contribution à la base de règles
  • 📆 :calendar: pour un changement de règle du à une évolution temporelle (en attendant mieux)