Skip to content

Contributing

achedon12 edited this page Sep 11, 2026 · 1 revision

Contributing

Contributions are welcome, especially hero analyses: the one kind of content no extraction will ever produce.

Writing an analysis

Analyses live in src/data/heros/, one entry per hero in one file per role, linked to the rest by the slug. An analysis contains: a summary, two paragraphs of commentary, strengths, weaknesses, annotated matchups and builds. The step-by-step guide is in CONTRIBUTING.md.

Do not touch src/data/jeu/ or public/visuels/: both are regenerated by the sync.

Setting up the project

npm install
cp .env.example .env.local
npm run dev            # http://localhost:3001

Branches

  • develop: ongoing work. Pull requests target it, and are merged by rebase or squash.
  • main: production, deployed on every push. To publish: git push origin develop:main once CI is green (fast-forward, no merge commit), or the Publier en production (publish to production) button; the sync data is pushed there every night, then carried over to develop. Pull develop with git pull --rebase.

See Data and sync for the details of deployment and branch protections.

Before opening a pull request

npm run lint
npm run typecheck
npm run test
npm run build

Commit rules

  • Messages in English, in the imperative, describing the intent.
  • No tool signatures in messages or in published content.

Clone this wiki locally