27 lines
1.4 KiB
Markdown
27 lines
1.4 KiB
Markdown
<!-- file: RULES.md -->
|
||
<!-- version: 25 -->
|
||
|
||
# Index normatif de `khadhroony-bot3`
|
||
|
||
`RULES.md` est l’unique fichier de règles conservé à la racine du workspace. Il constitue le point d’entrée obligatoire et renvoie vers les règles détaillées maintenues sous `docs/rules/`.
|
||
|
||
La lecture des documents suivants est obligatoire avant toute modification :
|
||
|
||
1. [`docs/rules/RULES_GENERAL.md`](docs/rules/RULES_GENERAL.md) — gouvernance, méthode de travail, documentation et livraisons ;
|
||
2. [`docs/rules/RULES_RUST.md`](docs/rules/RULES_RUST.md) — règles Rust réutilisables ;
|
||
3. [`docs/rules/RULES_SPECIFIC_KHADHROONY.md`](docs/rules/RULES_SPECIFIC_KHADHROONY.md) — architecture et conventions propres au workspace ;
|
||
4. [`docs/rules/CRATE_DOCUMENTATION_RULES.md`](docs/rules/CRATE_DOCUMENTATION_RULES.md) — contrat des `README.md`, `TODO.md`, `USAGE.md` et `CHANGELOG.md` de crates.
|
||
|
||
Ces règles sont cumulatives. En cas de conflit, la règle la plus stricte s’applique. Une exception doit être explicite, locale, bornée et documentée.
|
||
|
||
Les documents de `olddocs/` sont historiques et non normatifs. Ils peuvent servir de sources pour réécrire une documentation bot3, mais ne doivent pas être copiés ou activés automatiquement.
|
||
|
||
Toute tranche commence par :
|
||
|
||
```bash
|
||
cargo fmt --all
|
||
python3 scripts/audit_rust_workspace_rules.py
|
||
```
|
||
|
||
Une validation n’est déclarée réussie que si elle a réellement été exécutée.
|