Conseils pour le style de code des contributeurs
parent
a11414a2da
commit
83a3c4d058
|
@ -1,18 +1,27 @@
|
|||
## Style du code
|
||||
|
||||
Nous utilisons [Prettier](https://prettier.io/). 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](http://eslint.org/), 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: `:sparkles: ` when formatting files
|
||||
* 🎨 `: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: `:sparkles:` when formatting files
|
||||
|
||||
Et ceux spécifiques au projet :
|
||||
- :gear: `:gear:` pour une contribution au moteur qui traite les YAML
|
||||
- :hammer: `:hammer:` pour une contribution à la base de règles
|
||||
- :calendar: `:calendar:` pour un changement de règle du à une évolution temporelle (en attendant mieux)
|
||||
|
||||
* :gear: `:gear:` pour une contribution au moteur qui traite les YAML
|
||||
* :hammer: `:hammer:` pour une contribution à la base de règles
|
||||
* :calendar: `:calendar:` pour un changement de règle du à une évolution temporelle (en attendant mieux)
|
||||
|
|
Loading…
Reference in New Issue