erplibre/.claude/rules/04-code-conventions.md
Mathieu Benoit f9edaa4e59 [ADD] git : un garde-fou commit-msg pour le sujet
Rien ne tenait la convention sur le sujet : le tag est respecté partout,
c'est la longueur qui glisse. Le hook refuse le mécanique et rien de plus
— tag absent, plus de 72 caractères, sujet ouvrant sur une citation ; dire
sur quoi porte le code reste un jugement qu'aucun hook ne rendra. Il compte
des caractères et non des octets, sans quoi un sujet français de 72
caractères tomberait sur ses accents. Le refus enseigne le repli vers des
mots-clés plutôt que la troncature, et nomme `--no-verify` : un garde-fou
qui refuse trop est désinstallé. Les tests pèsent donc autant les
acceptations, « Merge branch » ou fixup de rebase. Le lanceur balaie le
préfixe test_git_ : 32 tests jamais exécutés, le total va de 1021 à 1071.

--- EN ---

Nothing held the subject convention: the tag is respected everywhere, it
is the length that slips. The hook refuses the mechanical and nothing more
— no tag, over 72 characters, a subject opening on a quotation; whether it
says what the code is about stays a judgement no hook will make. It counts
characters, not bytes, or a 72-character French subject would fall on its
accents. The refusal teaches the fallback to keywords rather than
truncation, and names `--no-verify`: a guard rail that refuses too much
gets uninstalled. So the tests weigh the acceptances as much, a "Merge
branch" or a rebase fixup. The runner sweeps the test_git_ prefix: 32
tests never ran, and the total goes from 1021 to 1071.

Assisted-by: Claude Opus 5
(cherry picked from commit c9abf4d1b723ae8ff3762d39bfe1d6982400d12d)
2026-08-29 02:11:04 -04:00

3.2 KiB
Raw Blame History

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.

Si le travail n'entre décidément pas dans une phrase de 72 caractères, ne pas en écrire une amputée : des mots-clés qui résument, séparés par des virgules, en disent plus dans la même place — [FIX] proxmox : pmxcfs à terre, pvesm muet, diagnostic à la source. C'est un repli, pas un défaut : la phrase reste préférable quand elle tient.

Un garde-fou refuse le mécanique — tag absent, plus de 72 caractères, sujet qui s'ouvre sur une citation :

git config core.hooksPath script/git/hooks   # une fois par clone
git commit --no-verify                       # exception légitime

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.