Mathieu Benoit
55a093a86d
Le manuel encadrait le corps en détail — pourquoi, dix lignes par langue, ce qu'on ne répète pas du diff — et ne disait du sujet que « courte, à l'impératif ». Le sujet est pourtant lu cent fois pour une fois que le corps l'est : git log --oneline, un blame, un bisect, une note de version. Faute de règle, les sujets dérivent vers le symptôme et la métaphore, qui se lisent bien sans nommer la partie du système en jeu. La règle ajoute une épreuve, pas un gabarit : lire le sujet seul, sans diff ni corps, et savoir ce qui change et où. Les trois exemples avant/après viennent de l'historique du dépôt, un exemple inventé ne convainquant personne. --- EN --- The manual framed the body in detail — why, ten lines per language, what not to repeat from the diff — and said of the subject only that it be short and imperative. Yet the subject is read a hundred times for every reading of the body: git log --oneline, a blame, a bisect, a release note. With no rule, subjects drift towards the symptom and the metaphor, which read well without naming the part of the system at stake. The rule adds a test, not a template: read the subject alone, with no diff and no body, and be able to say what changes and where. The three before/after pairs come from the repository's own history, an invented example convincing nobody. Assisted-by: Claude Opus 5 (cherry picked from commit c86357eab899c65f41287d4f19e88d0da98285c4)
56 lines
2.6 KiB
Markdown
56 lines
2.6 KiB
Markdown
# Conventions de code
|
||
|
||
Le formatage et le lint sont entièrement décrits par les fichiers de
|
||
configuration du dépôt — les lire plutôt que de supposer : `.flake8`,
|
||
`.editorconfig`, et les sections `[tool.black]` / `[tool.isort]` de
|
||
`pyproject.toml`. `make format` applique l'ensemble.
|
||
|
||
Prettier (via npm) formate XML/JSON/YAML ; `.editorconfig` donne les
|
||
indentations par type de fichier.
|
||
|
||
## Git
|
||
- Branches : `develop` (développement), `master` (production)
|
||
- Pas de submodules Git — utilise **Google Repo** pour les addons
|
||
- Manifests XML dans `manifest/` pour chaque version Odoo
|
||
- Format de commit : `[TYPE] portée : sujet`, sujet à l'impératif, 72
|
||
caractères au plus. Tags réellement utilisés : `[UPD]`, `[FIX]`, `[ADD]`,
|
||
`[IMP]`, `[REF]`.
|
||
|
||
### Le sujet
|
||
|
||
Le sujet est lu cent fois pour une fois que le corps l'est — `git log
|
||
--oneline`, un blame, une note de version, un bisect. Il a une seule tâche :
|
||
dire **sur quoi porte le code**.
|
||
|
||
L'épreuve : le lire seul, sans diff ni corps. Sait-on quelle partie du système
|
||
est en jeu, et ce qui y est désormais différent ? Sinon il n'est pas fini.
|
||
|
||
Nommer la chose, puis ce qui change pour elle. Le symptôme, le message d'erreur
|
||
cité et la métaphore sont des PREUVES, et une preuve va dans le corps — un
|
||
sujet bâti sur elles se lit bien et n'apprend rien. La portée dit OÙ, les mots
|
||
après le deux-points doivent dire QUOI.
|
||
|
||
Le sujet résume le commit ENTIER, pas sa plus grosse pièce. S'il lui faut un
|
||
« et » entre deux choses sans rapport, c'étaient deux commits.
|
||
|
||
Le mode d'emploi complet, avec des exemples avant/après pris dans l'historique
|
||
de ce dépôt, est dans `conf/template_claude_commands_commit.md`.
|
||
|
||
### Tout commit assisté par IA
|
||
|
||
Trois exigences, sans exception — `AI_POLICY.md` en donne la raison :
|
||
|
||
- Trailer `Assisted-by: <modèle>`, une ligne par modèle. C'est **binaire** :
|
||
il y a eu IA ou non, aucun seuil à apprécier.
|
||
- **Jamais** d'IA dans `Co-authored-by:` — ce champ est réservé aux humains.
|
||
- Corps **bilingue** : le corps, puis `--- FR ---` (ou `--- EN ---`, le
|
||
marqueur nomme la langue de ce qui SUIT), puis la traduction.
|
||
|
||
Court et direct : **10 lignes par langue**, 15 est déjà long. Le corps dit
|
||
pourquoi c'était nécessaire, puis s'arrête. Rien de ce que le diff montre
|
||
déjà ; on garde le symptôme, le chiffre mesuré et la vérification.
|
||
|
||
Le mode d'emploi complet — résolution dynamique du modèle, gabarit, identité
|
||
git, taille des correctifs — est dans
|
||
`conf/template_claude_commands_commit.md`, déployable en `/commit` par
|
||
`TODO › Execute › GPT code › Claude configs`.
|