Links

Contribuer à un évènement

Contribuer à un évènement se fait relativement facilement. La première étape consiste à vous rendre sur la page des issues des évènements. (lien ci-dessous)
Page des issues listant les évents en cours de création
La page d'une issue est composée de plusieurs éléments principaux :
  • Le titre de l'évent
  • L'ID de l'évent
  • Le résumé de l'évent
  • Les personnes qui travaillent dessus
  • Les étiquettes
Une fois vos modifications effectuées, remplissez le questionnaire nommé "Commit changes" et surtout le premier champ. Résumez rapidement les modifications que vous avez effectuées. Vous devez également inclure le lien vers l'issue dans le message de commit en utilisant #23 (en remplaçant 23 par l'id de l'évent sur lequel vous travaillez). Ceci est absolument PRIMORDIAL, en effet si ce tag n'est pas présent, les modifications ne seront pas affichées sur la page de l'issue.
Si vous débutez essayez de repérer les différents éléments de la liste ci-dessus sur la page de l'issue.
Vous n'avez pas besoin de maîtriser chaque aspect de l'interface pour nous aider, ne prenez pas peur face à l'austérité de cette dernière. Écrire un évent est en réalité très simple. La première étape consiste à sélectionner l'évent sur lequel vous souhaitez travailler.
La première étape consiste à se rendre sur la page de l'issue de l'évent choisi et à vérifier les discussions éventuelles qui s'y trouvent. Précédemment j'avais choisi l'évènement #25 pour illustrer ce guide mais comme il est déjà assigné à 2 rédacteurs et qu'ils ont récemment apporté des modifications à l'issue, je vais m'orienter vers un autre évent.
Comme on peut le voir à droite: 2 personnes sont assignées à l'évent.
L'évènement #23 semble un peu plus abandonné, il constitue un bon choix pour contribuer.
La dernière modification date de 23 jours et personne n'est assigné à l'évènement
On remarque également que cet évènement possède le tag "en rédaction".
on peut voir les labels dans la colonne de droite de l'issue
N'hésitez pas à vous balader dans les différentes pages pour vous familiariser avec les différentes possibilités offertes par Github. En cliquant sur une modification sur la page de l'issue de l'évènement il est par exemple possible de visionner les modifications faites sur l'évènement comme ci-dessous.
Il est également possible de laisser des commentaires sur les modifications via ces écrans
L'étape suivante consiste à trouver le fichier de l'évènement pour le modifier. Pour cela il faut d'abord revenir sur la page d'accueil du repo puis naviguer vers le fichier de l'évènement. Ici, nous modifions l'évènement 23 donc c'est le fichier 23.md que nous cherchons :
Le fichier se trouve à l'adresse : markdown/fr/23.md
Il est alors possible de lire l'évènement dans son état actuel. Pour le modifier, il faut cliquer sur le petit crayon en haut à droite :
Il est également possible de voir l'historique des modifications en cliquant sur "Blame"
La modification de l'évènement est ensuite faite avec cette interface. Les règles de mises en page sont assez simples :
  • Mettre un # devant le titre, en haut du fichier
  • Respecter la mise en forme déjà en place si il y en a une
Pour plus de conseils sur le style d'écriture, veuillez vous référer à la page suivante de ce guide si elle est disponible.
Il est possible de voir un aperçu du résultat avec le bouton "Preview changes"
Quand vous avez terminé de modifier l'évènement il est EXTRÊMEMENT IMPORTANT de décrire les modifications effectuées en suivant la procédure décrite ci-dessous.
Une fois que l'issue a été taguée et que les modifications ont été faites vous pouvez cliquer sur commit changes.
Une fois le bouton "commit changes" pressé, il ne sera plus possible de modifier votre message de commit, soyez vigilant à ne pas avoir oublié le tag de l'issue !
Une fois le commit effectué, vos modifications apparaissent sur la page du fichier de l'évent.
Notez que le message de mon commit est présent et que j'apparais désormais dans les contributeurs
Sur la page de l'issue de l'évent, on peut également voir le commit apparaître.
Tout en bas, mon commit apparaît désormais.
Votre contribution est réussie ! Vous pouvez désormais contribuer à nouveau à un autre évènement ! Merci d'avoir suivi ce guide !