mesh/docs/docs_headers_template.md

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 l’agent (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 d’agents recommandés

• Claude
• Codex
• SubAgent:SecurityReview
• SubAgent:PerfReview
• SubAgent:CodeReview
• Automation:<nom>

---

Templates par langage

Rust (.rs)

Création (début de fichier)

// Created by: <agent_name>
// Date: YYYY-MM-DD
// Purpose: <short description>
// Refs: <optional>

Modification majeure (début de fichier)

// Modified by: <agent_name> — YYYY-MM-DD — <reason>

Modification ponctuelle (fin de ligne)

let timeout_ms = 1200; // Modified by: Codex — 2025-12-29 — tune retry timeout

---

Python (.py)

Création

# Created by: <agent_name>
# Date: YYYY-MM-DD
# Purpose: <short description>
# Refs: <optional>

Modification ponctuelle

MAX_CHUNK = 262144  # Modified by: Claude — 2025-12-29 — align with 256KB chunking

---

TypeScript / JavaScript (.ts, .tsx, .js)

Création

// Created by: <agent_name>
// Date: YYYY-MM-DD
// Purpose: <short description>
// Refs: <optional>

Modification ponctuelle

const WS_PATH = "/ws"; // Modified by: Codex — 2025-12-29 — keep routing consistent

---

HTML

<!--
Created by: <agent_name>
Date: YYYY-MM-DD
Purpose: <short description>
Refs: <optional>
-->

---

CSS

/*
Created by: <agent_name>
Date: YYYY-MM-DD
Purpose: <short description>
Refs: <optional>
*/

---

YAML (.yml, .yaml)

# Created by: <agent_name>
# Date: YYYY-MM-DD
# Purpose: <short description>
# Refs: <optional>

---

TOML (.toml)

# Created by: <agent_name>
# Date: YYYY-MM-DD
# Purpose: <short description>
# Refs: <optional>

---

Markdown (.md)

<!--
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.