matteorlt / matteorlt/Task-Manager

Code Review globale: qualité, cohérence et maintenabilité

Open
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted review
Dominant language
TypeScript
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

# 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.
- **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.
---

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inventorying the client and server, then read the README, .env.example, npm scripts, and existing tests to map the current architecture and developer workflow. Produce docs/code-review.md with findings, risks, prioritized quick wins, effort estimates, and a remediation plan; create 8–12 actionable issues from the report and document success indicators.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, markdown, mysql, node.js, typescript
Domain
backend, databases, devops, documentation, frontend, full-stack, security, testing
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.