Bonnes pratiques GitHub pour MDN

Cette page contient les bonnes pratiques pour travailler avec GitHub et contribuer à MDN, principalement axées sur la façon de travailler avec les issues qui sont les tickets/points à traiter, référencés sur les dépôts GitHub.

Choisir une issue GitHub sur laquelle travailler

  1. Écrivez un commentaire dans le ticket en disant que vous aimeriez vous en occuper, et nous vous y affecterons.
    • Si quelqu'un d'autre est déjà affecté au problème :
      1. Si cela s'est passé il y a plus d'une semaine et qu'il n'y a pas eu beaucoup d'activité, mentionnez-les personnes et demandez-leur si vous pouvez reprendre le ticket ou les aider à terminer le projet.
        • S'ils sont d'accord pour que vous preniez l'issue, nous vous y affecterons et nous les retirerons.
        • S'ils sont d'accord pour que vous le preniez et qu'une partie du travail a déjà été effectuée, ou si l'accord prévoit que vous les aidiez, nous vous y affecterons à leurs côtés.
      2. Si c'était il y a moins d'une semaine, soyez patient et donnez-leur une chance d'y travailler.
  2. Si l'issue a été marquée comme terminée mais qu'une revue est nécessaire et que vous souhaitez relire, mentionnez la personne (@pseudo) dans les commentaires et dites que vous allez relire ses modifications.

Lorsque vous êtes affecté⋅e à une issue

  1. Déterminez le reste des travaux à effectuer.
    • Si l'issue est bien décrite et que le travail est assez évident, foncez et faites-le.
    • Si l'issue n'est pas bien décrite, et/ou si vous n'êtes pas sûr⋅e de ce qui est nécessaire, n'hésitez pas à @mentionner la personne à l'origine et à demander plus d'informations.
    • Si vous ne savez toujours pas à qui vous adresser, demandez de l'aide dans le salon de discussion MDN Web Docs FR sur Matrix.
  2. Une fois que vous pensez avoir résolu une issue, demandez une revue dans les commentaires.
  3. Une fois qu'une issue a été revue avec succès et que les commentaires ont reçu une réponse positive, vous pouvez la marquer comme terminée.
  4. Si vous n'avez plus le temps de travailler sur une issue, faites-le nous savoir dans un commentaire afin que nous puissions l'attribuer à quelqu'un d'autre.