generated from gilles/template-webapp
Initial commit
This commit is contained in:
34
docs/STYLEGUIDE.md
Normal file
34
docs/STYLEGUIDE.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Guide de style
|
||||
|
||||
Ce guide définit les conventions de code et de documentation.
|
||||
|
||||
---
|
||||
|
||||
## Légende des zones
|
||||
- `<A REMPLIR - PROJET> (exemple: à personnaliser — a supprimer)` : à compléter par toi selon le projet.
|
||||
- `<A COMPLETER PAR AGENT>` : à compléter par un agent spécialisé.
|
||||
|
||||
---
|
||||
|
||||
## 1. Nommage
|
||||
- Variables / fonctions : <A COMPLETER PAR AGENT>
|
||||
- Fichiers / dossiers : <A COMPLETER PAR AGENT>
|
||||
- API endpoints : <A COMPLETER PAR AGENT>
|
||||
|
||||
## 2. Formatage
|
||||
- Formatter / linter : <A COMPLETER PAR AGENT>
|
||||
- Règles principales : <A COMPLETER PAR AGENT>
|
||||
|
||||
## 3. Tests
|
||||
- Nommage des tests : <A COMPLETER PAR AGENT>
|
||||
- Structure des tests : <A COMPLETER PAR AGENT>
|
||||
|
||||
## 4. Documentation
|
||||
- Doc obligatoire : <A REMPLIR - PROJET> (exemple: README + ARCHITECTURE — a supprimer)
|
||||
- ADR (Architecture Decision Record) : <A COMPLETER PAR AGENT>
|
||||
|
||||
---
|
||||
|
||||
## Exemple (a supprimer)
|
||||
- Formatter : `prettier` + `eslint`.
|
||||
- Tests : `feature_x.test.ts`.
|
||||
Reference in New Issue
Block a user