Skip to content

Fichiers communautaires GitHub, badges npm/CI et section Contributing - #2

Open
pasquelin wants to merge 1 commit into
developfrom
chore/repo-page
Open

Fichiers communautaires GitHub, badges npm/CI et section Contributing#2
pasquelin wants to merge 1 commit into
developfrom
chore/repo-page

Conversation

@pasquelin

Copy link
Copy Markdown
Owner

Ce que ça change et pourquoi

La page GitHub du dépôt n'avait ni description, ni sujets, ni site (posés hors git, côté réglages du dépôt), et surtout aucun des fichiers qu'un visiteur cherche avant de contribuer. Le profil communautaire était à 42 %.

Cette PR apporte la partie versionnée :

  • .github/CONTRIBUTING.md — installation pnpm, modèle de branches develop → PR (main = release), worktree obligatoire (l'index git est partagé entre sessions d'un même clone), pnpm validate comme unique garde-fou avec le détail de ses neuf étapes, les règles non négociables du CLAUDE.md (tout est config, pas de any, type jamais interface, zéro alloc en boucle de frame, le latest ref pattern est délibéré) et la liste de ce qu'« une feature finie » exige.
  • .github/SECURITY.md — versions suivies (0.x : seule la dernière), signalement privé par avis de sécurité GitHub plutôt qu'une adresse e-mail en clair (cohérent avec la 0.6.0 qui a retiré l'e-mail du README et du package.json), périmètre explicite — les jetons Cesium Ion / Google appartiennent à l'application hôte, les peer deps et le SDK MIL-STD externalisé à leurs auteurs — et la vérification de provenance (npm audit signatures).
  • .github/CODE_OF_CONDUCT.md — Contributor Covenant 2.1, texte officiel repris tel quel, seul le canal de signalement renseigné.
  • Gabarits d'issues (bug, feature) et de PR — le gabarit de bug demande d'entrée la version, le fond de carte en cours et la console ; le gabarit de PR reprend la checklist du dépôt (docs FR et EN, pnpm llms, exemple branché, entrée de changelog).
  • README — badges npm (version, téléchargements) et statut CI, plus une section « Contributing » qui pointe ces fichiers, le changelog et les releases.

Aucun code de la lib n'est touché.

Contrôles

  • pnpm validate vert dans le worktree : 94 fichiers de test, 962 tests, lint et format compris.
  • Les trois ISSUE_TEMPLATE/*.yml parsent.
  • Badges vérifiés en direct : npm v0.6.0, 418/month, CI verte sur main. Le badge bundlephobia a été écarté, le service répondant « rate limited ».

À faire à la main, hors PR

L'image de prévisualisation sociale (Settings → Social preview) n'a pas d'API : c'est ce qui s'affiche quand le lien du dépôt est partagé sur LinkedIn, Slack ou X. docs/assets/photorealistic-3d.webp recadré en 1280×640 ferait l'affaire.

https://claude.ai/code/session_0193RBy6GX55P21PvtDxPBwZ

Le README était déjà une vitrine, mais la page GitHub autour restait nue :
ni description, ni sujets, ni site — et surtout aucune réponse aux trois
questions qu'un visiteur pose avant de contribuer. Où j'ouvre une branche ?
Qu'est-ce qui doit être vert avant de pousser ? Où je signale une faille
sans la rendre publique ?

- CONTRIBUTING : le modèle `develop`, le worktree obligatoire (l'index git
  est partagé entre sessions du même clone), `pnpm validate` comme unique
  garde-fou, les règles non négociables et ce qu'« une feature finie » veut
  dire — docs FR+EN, llms régénérés, exemple branché, entrée de changelog.
- SECURITY : signalement privé par avis GitHub plutôt qu'une adresse en
  clair, périmètre explicite (les jetons Cesium/Google sont à l'hôte, pas à
  la lib) et la vérification de provenance du paquet.
- CODE_OF_CONDUCT : Contributor Covenant 2.1, texte officiel non modifié.
- Gabarits d'issues et de PR : ils demandent d'entrée ce qu'on redemandait
  toujours ensuite — version, fond de carte en cours, reproduction.
- README : badges npm et CI, plus une section qui pointe tout cela.

Claude-Session: https://claude.ai/code/session_0193RBy6GX55P21PvtDxPBwZ
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant