documentationhelp wantedreview
仓库指标
- 星标
- (1 个星标)
- PR 合并指标
- (PR 指标待抓取)
描述
Description
Objectif : réaliser un audit complet du code (client + serveur) afin d’améliorer la qualité globale, la cohérence technique et la maintenabilité.
La review doit couvrir aussi bien l’architecture que l’expérience développeur.
Portée
Backend
- Architecture & séparation des responsabilités : routes, contrôleurs, services, utilitaires.
- Cohérence API : conventions de nommage, schémas JSON, statuts HTTP, gestion des erreurs.
- Sécurité :
- Gestion des JWT (rotation, expiration, refresh).
- CORS + rate limiting.
- Validation des entrées côté serveur.
- Gestion des secrets.
- Performance :
- Requêtes N+1 et indexes DB.
- Pagination / tri des payloads.
- Hydratation côté client.
- Tests :
- Cas critiques : auth, invitations, accept/reject, tâches/événements.
- Mocks réalistes alignés avec les requêtes SQL.
Frontend
- Accessibilité (ARIA, focus management).
- i18n FR cohérente et centralisée.
- Gestion des dates (timezone unifiée).
- Uniformité UI : boutons, cards, dialogues, toggles, états de chargement.
- Navigation & routing fluide.
Developer Experience (DX)
- Scripts
npm,README,.env.example. - Logging structuré.
- Linter / formatter alignés.
- Conventions de commit / pull request documentées.
Livrables attendus
- Rapport détaillé :
- Points forts / faiblesses.
- Risques identifiés.
- Quick wins faciles à corriger.
- Liste d’issues actionnables :
- Classées par priorité
P0 / P1 / P2. - Avec estimation d’effort.
- Classées par priorité
- Recommandations concrètes :
- Snippets de config.
- Exemples de refactors simples.
Critères d’acceptation
- ✅ Rapport livré en Markdown dans le repo (ex :
docs/code-review.md). - ✅ 8 à 12 issues créées automatiquement à partir du rapport :
- Titre clair.
- Description + critères d’acceptation.
- ✅ Plan de remédiation synthétique :
- Ordre d’attaque.
- Actions parallélisables.
- Indicateurs de succès.