Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (40 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

52 lines (40 loc) · 2.29 KB
Raw

Contribuer à my-git-stats

Merci de vouloir contribuer ! Ce projet est ouvert : aucun accès en écriture n'est nécessaire. Tout passe par un fork et une pull request.

En bref

  1. Forke le dépôt (bouton Fork en haut à droite sur GitHub).
  2. Clone ton fork puis crée une branche : 
    git clone https://github.com/<ton-compte>/my-git-stats.git
cd my-git-stats
git checkout -b feat/ma-fonctionnalite
  3. Installe et lance : 
    npm install
cp .env.local.example .env.local   # ajoute ton PAT GitHub dans .env.local
npm run dev
  4. Vérifie avant de pousser : 
    npm run lint      # style + erreurs
npm run format    # applique Prettier
npm test          # tests unitaires
  5. Pousse ta branche et ouvre une Pull Request vers dev.

Prérequis

  • Node.js >= 22 (la CI teste sur 22 et 24).
  • Un Personal Access Token GitHub pour les tests contre l'API réelle. Il va uniquement dans .env.local (ignoré par git). Ne committe jamais de token.

Conventions

  • Branches : feat/..., fix/..., docs/..., chore/....
  • Commits : messages clairs à l'impératif. Les Conventional Commits sont appréciés mais pas obligatoires.
  • Signature : les commits doivent être signés (GPG/SSH) pour apparaître « Verified ». Configure git config commit.gpgsign true et ta user.signingkey. Voir la doc GitHub.
  • Style : ESLint + Prettier gèrent le formatage. Ne te bats pas contre eux, lance npm run format.
  • Tests : ajoute ou mets à jour les tests quand tu changes une logique (test/). Le smoke test hors-ligne (npm run smoke) doit toujours passer.

Que peut-on faire ?

Regarde les issues ouvertes, en particulier celles étiquetées good first issue. Des idées d'évolution sont listées dans le README (nouvelles cartes, cache, pagination…). Pour un changement important, ouvre d'abord une issue pour en discuter avant de coder.

Checklist de PR

  • npm run lint passe.
  • npm test passe.
  • La description explique le quoi et le pourquoi.
  • Pas de secret ni de .env.local committé.

Toute PR est relue avant d'être fusionnée. Merci !