Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (35 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 2.32 KB
Raw

Contribuer à MemoForge

🌐 Français · English

Merci de contribuer. Le projet est vanilla (modules ES, sans build) et vise une qualité « AAA » : logique testée, UI découplée.

Prérequis & lancement

  • Node ≥ 22 (le runner de tests et la couverture natifs sont utilisés).
  • Lancer le jeu : npm run serve puis http://localhost:8000 (les modules ES exigent HTTP).
  • Tests : npm test (voir docs/TESTING.md).

Architecture

Trois couches, dépendances vers le bas : engine/ → game/ → ui/. Le moteur ne touche jamais au DOM. Détails : docs/ARCHITECTURE.md et ADR 0001.

Style « Norme-lite » (inspiré de la Norme 42)

  • const/let, jamais var.
  • Fonctions courtes et à responsabilité unique.
  • Nommage explicite (pas d'abréviations obscures).
  • Pas de code mort ni de console.log oubliés.

Le lint (npm run lint, issue #2) formalisera ces règles.

Git, branches & PR (GitFlow)

La branche par défaut est develop ; toutes les PR de feature la ciblent. Le modèle complet (develop → staging → main, releases, protection de branche) est dans docs/WORKFLOW.md.

  • Brancher depuis develop à jour : git switch develop && git pull && git switch -c feature/<sujet>.
  • Un commit raconte une intention ; message conventionnel (feat:/fix:/test:/docs:/chore:) ; référencer l'issue ((#N)).
  • Ouvrir une PR vers develop avec le gabarit (Closes #N, AC cochés, tests verts).
  • La CI doit être verte (lint · test · couverture ≥ 90 % · build · écrans visuels · budgets perf) avant merge — c'est imposé par la protection de branche.
  • Squash-merge puis élaguer la branche.
  • Les releases (promotion develop → staging → main, tag, déploiement) sont réservées aux mainteneurs.

Ajouter du contenu (niveaux)

Un niveau est de la donnée dans src/game/levels.js (cible, palette, critères). Aucune modification du moteur n'est nécessaire pour un niveau utilisant les briques existantes.

Étendre le moteur

Nouvelle mécanique = étendre evalExpr/writePlace (interpreter.js) et, si besoin, memory.js — avec des tests unitaires maintenant la couverture ≥ 90 %.