Files
ms1readerv4/.cursor/rules/ms1reader-documentation.mdc
stephan ea49f2c94f Aligner le dépôt Reader sur le modèle MS1 (gitignore, règles Cursor, deploy_dev).
Retire .env et les artefacts writable du tracking; versionne deploy_dev.php pour survivre à git clean -fd.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-19 10:21:52 -04:00

36 lines
1001 B
Plaintext

---
description: Documentation du code et des changements MS1 Reader
alwaysApply: true
---
# Documentation MS1 Reader
## Commentaires dans le code
- Documenter la **logique métier non évidente**.
- Pour une nouvelle fonction ou un bloc important : courte description du **pourquoi**, pas seulement du quoi.
- Référencer le ticket : `// MSREAD-xxxx` ou bloc PHPDoc.
- Langue : **français** pour les commentaires métier, sauf si le fichier est entièrement en anglais.
## Scripts SQL
En-tête obligatoire en tête de fichier :
```sql
-- MSREAD-xxxx — Titre court
-- Contexte / prérequis
-- Notes (idempotent, safe, etc.)
```
- Préférer les scripts **idempotents** quand c'est possible.
## Résumé des changements (agent)
À la fin d'une implémentation, fournir :
1. **Quoi** — comportement ajouté ou corrigé.
2. **Où** — fichiers principaux touchés.
3. **Déploiement** — SQL, config, étapes manuelles.
Ne pas créer de fichiers README ou docs hors demande explicite.