Contributions au code

Dans ce guide, vous obtiendrez un aperçu du processus pour contribuer comprenant l’ouverture d’un ticket, la création d’une PR, la révision et la fusion de la PR.

Si vous souhaitez contribuer au code de ce projet, veuillez suivre les étapes ci-dessous :

Résoudre un ticket

Parcourez nos tickets existants^ pour trouver celui qui vous intéresse. Vous pouvez affiner votre recherche en utilisant les labels comme filtres. Si vous trouvez un ticket à résoudre, n’hésitez pas à ouvrir une demande de résolution avec une correction.

Apporter des modifications

Dupliquez le dépôt (créez un « fork »).
- En utilisant GitHub Desktop :
  - Bien démarrer avec GitHub Desktop^ vous guidera dans la configuration de Desktop.
  - Une fois Desktop configuré, vous pouvez l’utiliser pour dupliquer le dépôt^ !
- En utilisant la ligne de commande :
  - Dupliquez le dépôt^ afin que vous puissiez apporter vos modifications sans affecter le projet d’origine jusqu’à ce que vous soyez prêt à les fusionner.
Installez ou mettez à jour Node.js et pnpm vers les versions spécifiées dans .prototools^.
Créez une branche opérationnelle et commencez vos modifications !
Écrivez des tests pour vos modifications, le cas échéant.
Mettez à jour la documentation, si nécessaire.

Validez votre mise à jour

Validez les modifications une fois que vous en êtes satisfait en créant un commit.

Demande de fusion

Une fois les modifications terminées, créez une demande de fusion, également appelée PR ou « pull request » en anglais.

Remplissez le modèle « Ready for review » afin que nous puissions examiner votre demande de fusion. Ce modèle permet aux réviseurs de comprendre vos modifications et l’objectif de votre demande de fusion.
N’oubliez pas de lier la PR au ticket^ si vous en résolvez un.
Cochez la case autoriser les modifications du responsable^ afin que la branche puisse être mise à jour pour une fusion. Une fois votre PR soumise, un membre de l’équipe Docs l’examinera. Nous pourrons vous poser des questions ou vous demander des informations complémentaires.
Nous pouvons demander que des modifications soient apportées avant qu’une PR puisse être fusionnée, soit en utilisant des suggestions de modifications^, soit via des commentaires dans la demande de fusion. Vous pouvez appliquer les modifications suggérées directement via l’interface utilisateur. Vous pouvez apporter d’autres modifications à votre fork, puis les valider dans votre branche.
Au fur et à mesure que vous mettez à jour votre PR et appliquez les modifications, marquez chaque conversation comme résolue^.
Si vous rencontrez des problèmes de fusion, consultez ce tutoriel Git (en)^ pour vous aider à résoudre les conflits de fusion et d’autres problèmes.

Votre PR est fusionnée !

Félicitations ! L’équipe StudioCMS vous remercie. Votre contribution sera intégrée à la prochaine version.

Maintenant que vous faites partie de la communauté StudioCMS, vous pouvez nous aider à examiner d’autres PR, répondre aux questions et aider les autres contributeurs. Si ce n’est pas déjà fait, rejoignez notre serveur Discord^ pour vous connecter avec d’autres contributeurs et l’équipe StudioCMS.

Oh, et vous verrez votre visage dans la liste des contributeurs ! 🎉