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>
This commit is contained in:
35
.cursor/rules/ms1reader-documentation.mdc
Normal file
35
.cursor/rules/ms1reader-documentation.mdc
Normal file
@ -0,0 +1,35 @@
|
||||
---
|
||||
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.
|
||||
27
.cursor/rules/ms1reader-php-conventions.mdc
Normal file
27
.cursor/rules/ms1reader-php-conventions.mdc
Normal file
@ -0,0 +1,27 @@
|
||||
---
|
||||
description: Conventions PHP / CodeIgniter 4 — MS1 Reader
|
||||
globs: **/*.php,ci4app/app/**/*.php,www/**/*.php,public_html/**/*.php
|
||||
alwaysApply: false
|
||||
---
|
||||
|
||||
# Conventions PHP MS1 Reader
|
||||
|
||||
Code applicatif dans `ci4app/app/`, points d'entrée `www/` / `public_html/`.
|
||||
Ne pas imposer ces règles à `ci4app/system/`, vendors ou librairies tierces.
|
||||
|
||||
## Style à respecter
|
||||
|
||||
- **Suivre le fichier ouvert** : indentation, guillemets, style des `if` — ne pas « moderniser » PHP dans un diff parallèle.
|
||||
- Préférer les patterns CodeIgniter 4 déjà présents (Controllers, Models, Config, Filters).
|
||||
- Réutiliser helpers / libraries existants avant d'en créer.
|
||||
|
||||
## Qualité
|
||||
|
||||
- Code **propre et lisible** dans la zone modifiée ; pas de code mort ni de `var_dump` / `dd()` laissé en prod.
|
||||
- **Pas de sur-ingénierie** : pas d'abstraction pour un seul appel.
|
||||
- Sécurité : échapper les sorties HTML, Query Builder / requêtes préparées — pas de concat SQL brute.
|
||||
|
||||
## Config sensible
|
||||
|
||||
- Secrets et DB → `ci4app/.env` (gitignored). Ne jamais committer de mots de passe.
|
||||
- Exemple versionné : `ci4app/.env.example`.
|
||||
38
.cursor/rules/ms1reader-workflow.mdc
Normal file
38
.cursor/rules/ms1reader-workflow.mdc
Normal file
@ -0,0 +1,38 @@
|
||||
---
|
||||
description: Workflow MS1 Reader — JIRA, validation avant gros changements
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Workflow MS1 Reader
|
||||
|
||||
## Numéro JIRA
|
||||
|
||||
- Au début d'une tâche de développement (nouvelle feature, correctif, refactor), **demander le numéro JIRA** si l'utilisateur ne l'a pas fourni.
|
||||
- Ne pas bloquer une simple question ou une lecture du code — seulement quand on s'apprête à modifier des fichiers.
|
||||
- Référencer le ticket dans le code et les scripts SQL : `// MSREAD-xxxx` ou `-- MSREAD-xxxx — description` (ajuster le préfixe projet si différent).
|
||||
|
||||
## Portée des changements
|
||||
|
||||
- **Changement minimal** : corriger uniquement ce qui est demandé.
|
||||
- Pas de refactor large, renommage massif ou « nettoyage » opportuniste sans accord explicite.
|
||||
- Pour le code existant, privilégier la cohérence locale (fichier / module touché) plutôt qu'une modernisation globale.
|
||||
|
||||
## Git / déploiement (philosophie MS1)
|
||||
|
||||
- Développement sur branche **`dev`** ; **`master`** = référence prod.
|
||||
- Le serveur = **déploiement uniquement** (pas de commits sur le serveur).
|
||||
- Flux : push Windows → Gitea → webhook → `deploy_dev.php` → `deploy_dev.sh` (`fetch` + `reset --hard` + `clean -fd`).
|
||||
- Tout fichier nécessaire sur le serveur après un deploy (ex. `deploy_dev.php`) **doit être versionné**.
|
||||
|
||||
## Incohérences repérées
|
||||
|
||||
Quand du code voisin contredit le pattern du fichier ou du module :
|
||||
|
||||
1. **Signaler** brièvement l'incohérence à l'utilisateur.
|
||||
2. **Proposer** une correction ciblée ou l'alignement sur le pattern dominant.
|
||||
3. **Attendre confirmation** avant de corriger hors périmètre.
|
||||
|
||||
## Fin de tâche
|
||||
|
||||
- Résumer ce qui a changé (fichiers, comportement, SQL à exécuter).
|
||||
- Mentionner les étapes manuelles restantes (déploiement, import SQL, cache).
|
||||
Reference in New Issue
Block a user