AGENTS.md : la checklist de fin de tache rappelle que VERSION est la source unique de verite, incrementee a chaque commit par le hook, avec resynchronisation des derives et publication du tag au push ; ligne ajoutee a la cartographie documentaire. Suppression des captures de diagnostic (diag-*.png, ogdiag.png, state.png) et du script jetable tmp-verify-inline.cjs.
55 lines
2.8 KiB
Markdown
55 lines
2.8 KiB
Markdown
# AGENTS.md — Instructions obligatoires du dépôt ObsiGate
|
|
|
|
> Ces instructions s'appliquent à **toute** intervention (humaine ou IA) sur ce dépôt.
|
|
|
|
## Règle n°1 — Méthode de livraison unique
|
|
|
|
Avant toute tâche (fonctionnalité, bug, refactor), **lire et appliquer**
|
|
[`docs/DELIVERY_WORKFLOW.md`](./docs/DELIVERY_WORKFLOW.md) (Definition of Done).
|
|
Aucune tâche n'est terminée avant que sa checklist soit complète **et le CI vert**.
|
|
|
|
## Avant de commencer
|
|
|
|
1. Lire [`docs/ROADMAP.md`](./docs/ROADMAP.md) (travail à venir + index) et
|
|
[`docs/ISSUES_TODOLIST.md`](./docs/ISSUES_TODOLIST.md) (bugs).
|
|
2. Identifier ou créer l'**ID stable** (`#NN` pour une feature, `BUG-NNN` pour un bug)
|
|
et passer son statut à « en cours » **avant** de coder.
|
|
|
|
## À la fin de chaque tâche (obligatoire)
|
|
|
|
- Ajouter/mettre à jour les **tests unitaires**.
|
|
- Vérifications locales vertes : `pytest`, `ruff`, `mypy`, tests frontend (`E2E` si UI).
|
|
- Mettre à jour la documentation requise : `CHANGELOG.md` (`[Unreleased]`), `docs/ROADMAP.md`
|
|
(statut + index), fiche `docs/features/` **ou** `docs/archive/`, `docs/ISSUES_TODOLIST.md`,
|
|
guide utilisateur i18n FR/EN + README si impact utilisateur.
|
|
- **Commit** conventionnel référençant l'ID, puis **push**.
|
|
- Version : le fichier VERSION (racine du dépôt) est la **source unique de
|
|
vérité (MAJEUR.MINEUR.CORRECTIF), incrémenté automatiquement à chaque commit** par le hook
|
|
.githooks/prepare-commit-msg — feat → mineur, !: / BREAKING CHANGE → majeur, sinon
|
|
correctif. Le même commit resynchronise package.json, le desktop Tauri, README.md/
|
|
README.fr.md, docs/ROADMAP.md et publie la section [Unreleased] du CHANGELOG.md en
|
|
[X.Y.Z] — date ; le tag vX.Y.Z est créé au commit et publié au push (push.followTags).
|
|
Hooks à installer une fois par clone : scripts/install-hooks.sh. Garde-fou :
|
|
tests/test_version.py (détail : docs/DELIVERY_WORKFLOW.md §7).
|
|
- Vérifier le **CI Gitea vert** (jobs `lint`, `test`, `security`, `build`, `e2e`).
|
|
|
|
## Cartographie documentaire
|
|
|
|
| Sujet | Fichier |
|
|
|---|---|
|
|
| Méthode de livraison / DoD | `docs/DELIVERY_WORKFLOW.md` |
|
|
| Version livrée (source unique) | VERSION + scripts/bump_version.py |
|
|
| Travail à venir + index | `docs/ROADMAP.md` |
|
|
| Historique des versions | `CHANGELOG.md` |
|
|
| Conception par feature | `docs/features/<slug>.md` |
|
|
| Archive du complété | `docs/archive/COMPLETED_v1-v2.md` |
|
|
| Bugs / TODO | `docs/ISSUES_TODOLIST.md` |
|
|
| Build & releases | `docs/DEVELOPMENT_AND_RELEASES.md` |
|
|
| Standards de code | `docs/CONTRIBUTING.md` |
|
|
|
|
## Conventions
|
|
|
|
- Commits : `type: description` — `feat`, `fix`, `perf`, `refactor`, `docs`, `style`, `chore`, `test`.
|
|
- **Ne jamais** committer de secrets, clés ou tokens.
|
|
- Réponses et documentation en **français** ; respecter le style du code existant.
|