Skip to content

Contribution publique ​

Le dépôt source de SIA UI reste privé pour le moment. La contribution publique ne commence donc pas par une pull request sur le code, mais par un retour structuré dans le dépôt public BeatJo/sia-ui-site.

Ce dépôt public sert de guichet pour :

  • signaler un bug rencontré avec un paquet npm ou un composant copié par la CLI;
  • demander un composant, une variante ou un comportement;
  • corriger ou clarifier la documentation publiée;
  • poser une question d'usage.

Les contributions directes au code des packages (@sia-ui/react-web, @sia-ui/cli, @sia-ui/headless, etc.) se font sur invitation dans le dépôt source privé.

Parcours ​

Ce que voit un utilisateur ​

Depuis npm, les champs des paquets envoient vers les surfaces publiques :

  • homepage pointe vers la documentation et la démonstration publiées;
  • bugs.url pointe vers les issues du dépôt public;
  • repository pointe vers le dépôt public de contribution tant que le dépôt source reste privé.

Le README de chaque paquet rappelle aussi cette règle : les retours sont publics, le code source principal est privé, et les contributions code directes se font sur invitation.

Gabarits à mettre dans le dépôt public ​

Le dépôt public porte les gabarits d'issues adaptés aux utilisateurs :

  • anomalie.yml pour un bug de composant, de paquet ou de CLI;
  • composant.yml pour demander une nouvelle entrée ou une variante;
  • documentation.yml pour une page confuse, un exemple cassé ou un lien mort.

Ces fichiers vivent dans public-repo/.github/ISSUE_TEMPLATE/. Le script scripts/synchroniser-depot-public.mjs les copie dans .pages/, et le workflow Pages pousse ensuite .pages/ vers BeatJo/sia-ui-site.

Le dépôt public ne doit donc pas être corrigé à la main : une modification du processus de contribution se fait ici, dans le dépôt source, puis voyage à la publication suivante.

Quand inviter quelqu'un au dépôt privé ​

Une invitation au dépôt source se justifie seulement si la personne doit modifier le code réel : composants, CLI, registre, packages, tests ou documentation source. Un bug report, une demande de composant ou une capture d'écran ne nécessite pas cet accès.

Réponse type ​

Quand quelqu'un demande comment contribuer, répondre :

Merci. Le code source principal est privé pour le moment. Ouvre une issue sur BeatJo/sia-ui-site avec le gabarit adapté : bug, demande de composant ou documentation. Si une contribution code devient nécessaire, je t'inviterai au dépôt source.

Publié sous licence MIT.