This commit is contained in:
Gilles Soulier
2026-01-05 13:13:08 +01:00
parent 8e14adafc6
commit 1d177e96a6
149 changed files with 29541 additions and 1 deletions

View File

@@ -0,0 +1,172 @@
# Templates de headers — Traçabilité Mesh
Ce document définit les **templates de commentaires obligatoires** à utiliser lors de toute **création ou modification de code** dans le projet Mesh.
Objectifs :
- traçabilité claire (qui / quand / pourquoi),
- auditabilité hors Git,
- revues facilitées (sécurité, performance, architecture).
---
## Règles générales
- **Création de fichier** : ajouter un bloc de header en **début de fichier**.
- **Modification majeure** : ajouter une ligne `Modified by` en début de fichier (sous le header existant).
- **Modification ponctuelle** : ajouter un commentaire **en fin de ligne** ou juste au-dessus du changement.
### Champs obligatoires
- `Created by` / `Modified by` : nom de lagent (ex. `Claude`, `Codex`, `SubAgent:SecurityReview`).
- `Date` : format `YYYY-MM-DD`.
- `Purpose` / `Reason` : une ligne concise.
### Champs optionnels
- `Refs` : issue, ticket, PR, ou référence interne.
- `Scope` : module ou sous-système concerné.
---
## Noms dagents recommandés
- `Claude`
- `Codex`
- `SubAgent:SecurityReview`
- `SubAgent:PerfReview`
- `SubAgent:CodeReview`
- `Automation:<nom>`
---
## Templates par langage
### Rust (`.rs`)
**Création (début de fichier)**
```rust
// Created by: <agent_name>
// Date: YYYY-MM-DD
// Purpose: <short description>
// Refs: <optional>
```
**Modification majeure (début de fichier)**
```rust
// Modified by: <agent_name> — YYYY-MM-DD — <reason>
```
**Modification ponctuelle (fin de ligne)**
```rust
let timeout_ms = 1200; // Modified by: Codex — 2025-12-29 — tune retry timeout
```
---
### Python (`.py`)
**Création**
```python
# Created by: <agent_name>
# Date: YYYY-MM-DD
# Purpose: <short description>
# Refs: <optional>
```
**Modification ponctuelle**
```python
MAX_CHUNK = 262144 # Modified by: Claude — 2025-12-29 — align with 256KB chunking
```
---
### TypeScript / JavaScript (`.ts`, `.tsx`, `.js`)
**Création**
```ts
// Created by: <agent_name>
// Date: YYYY-MM-DD
// Purpose: <short description>
// Refs: <optional>
```
**Modification ponctuelle**
```ts
const WS_PATH = "/ws"; // Modified by: Codex — 2025-12-29 — keep routing consistent
```
---
### HTML
```html
<!--
Created by: <agent_name>
Date: YYYY-MM-DD
Purpose: <short description>
Refs: <optional>
-->
```
---
### CSS
```css
/*
Created by: <agent_name>
Date: YYYY-MM-DD
Purpose: <short description>
Refs: <optional>
*/
```
---
### YAML (`.yml`, `.yaml`)
```yaml
# Created by: <agent_name>
# Date: YYYY-MM-DD
# Purpose: <short description>
# Refs: <optional>
```
---
### TOML (`.toml`)
```toml
# Created by: <agent_name>
# Date: YYYY-MM-DD
# Purpose: <short description>
# Refs: <optional>
```
---
### Markdown (`.md`)
```markdown
<!--
Created by: <agent_name>
Date: YYYY-MM-DD
Purpose: <short description>
Refs: <optional>
-->
```
---
## Rappel obligatoire
Ces templates sont **normatifs** pour le projet Mesh. Toute génération de code (Claude, sous-agent, Codex, automatisation) doit les appliquer sans exception.