Skip to content

docs(repo): page GitHub pro — README enrichi + fichiers communautaires - #2

Merged
pasquelin merged 1 commit into
developfrom
docs/repo-pro
Sep 10, 2026
Merged

pasquelin merged 1 commit into
developfrom
docs/repo-pro

Conversation

@pasquelin

Copy link
Copy Markdown
Owner

Ce que fait cette PR

Le dépôt est public mais n'avait aucune vitrine : README de 18 lignes, aucun fichier communautaire, profil GitHub à ~40 %. Cette PR lui donne la même présentation que map3D.

README

En-tête centré, badges (CI, npm geopf/windy, React 19, Three.js ≥ 0.169, TypeScript strict, MIT), tableau des trois voies du contrat, tableau des plugins avec leur rôle réel et leur statut (publié / privé), installation, démarrage rapide, création d'un plugin, tableau des commandes, publication OIDC, résumé anglais repliable.

Le lien vers map3D était un placeholder https://github.com/… — corrigé.

.github/

Fichier Contenu
CONTRIBUTING.md garde-fou pnpm validater, modèle develop/main, worktree obligatoire, Conventional Commits en français, procédure d'ajout d'un plugin (dont le bootstrap NPM_TOKEN du premier publish)
CODE_OF_CONDUCT.md Contributor Covenant 2.1 (FR)
SECURITY.md signalement privé GitHub, périmètre, rappel « la clé Windy n'est jamais committée », vérification de la provenance
ISSUE_TEMPLATE/ gabarits bug / évolution / nouveau plugin + config.yml (issues vierges désactivées, liens vers le contrat de plugin et map3D)
PULL_REQUEST_TEMPLATE.md checklist alignée sur la CI (cible develop, validater, tests, CHANGELOG, pas de any, pas de peer dep déplacée)
dependabot.yml npm groupé hebdomadaire sur racine + packages + exemples (peer deps ignorées), actions mensuelles

Hors PR (déjà appliqué côté GitHub)

  • About : description, site web (https://pasquelin.github.io/map3D/), 20 topics
  • Wiki et Projects désactivés (activés mais vides)
  • Labels à trier et nouveau plugin créés (utilisés par les gabarits d'issue)
  • Signalement privé de vulnérabilité activé

Vérifications

  • La PR cible develop
  • Titre en Conventional Commits
  • Aucun fichier .ts/.tsx touché — validater inchangé, la CI le rejoue quand même
  • YAML des gabarits et de dependabot validés
  • Aucun secret, aucun any

https://claude.ai/code/session_01LyrKrzZwquqPdLf5JYwycx

Le dépôt était public sans vitrine : README de 18 lignes, aucun fichier
communautaire, profil GitHub à ~40 %. On donne au dépôt la même présentation
que map3D.

README : en-tête centré, badges (CI, npm geopf/windy, React 19, Three.js,
TypeScript strict, MIT), tableau des trois voies du contrat, tableau des
plugins avec leur rôle réel, installation, démarrage rapide, création d'un
plugin, tableau des commandes, publication OIDC, résumé anglais repliable.
Le lien vers map3D était un placeholder « github.com/… » — corrigé.

.github/ : CONTRIBUTING (garde-fou `pnpm validater`, modèle develop/main,
worktree obligatoire, Conventional Commits, ajout d'un plugin), CODE_OF_CONDUCT
(Contributor Covenant 2.1), SECURITY (signalement privé, périmètre, rappel sur
la clé Windy jamais committée, vérification de la provenance), trois gabarits
d'issue (bug, évolution, nouveau plugin) + config sans issue vierge, gabarit de
PR, et dependabot (npm groupé hebdomadaire, peer deps ignorées, actions
mensuelles).

Claude-Session: https://claude.ai/code/session_01LyrKrzZwquqPdLf5JYwycx
@pasquelin
pasquelin merged commit b4d58d1 into develop Sep 10, 2026
1 check passed
@pasquelin
pasquelin deleted the docs/repo-pro branch September 10, 2026 09:47
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