7 Contribuer
Pour contribuer, il faudra d’abord vous créer un compte GitHub. GitHub est une plateforme destinée à héberger du code et à la collaboration. Par l’utilisation de Git, elle permet surtout d’assurer un suivi des modifications de fichiers et de quantifier les modifications sur ces fichiers.
Votre première contribution aux comptes-rendus risque de vous paraître un peu difficile en raison de la complexité de cette plateforme. En effet, Git et GitHub sont des outils puissants, mais complexe et peuvent être difficile à apprivoiser au premier abord. Cependant, après une première exposition, le processus décrit plus bas devrait devenir un peu plus facile. Si vous voulez de l’aide lors de cette première contribution ou si vous avez des questions ou des difficultées, n’hésitez pas à contacter un membre de l’équipe de révision et il nous fera plaisir de vous assistez lors de la création de vos comptes-rendus.
À noter que l’intégration des modifications au site ne sont pas automatiques. Elles doivent d’abord être approuvées par un membre de l’équipe de révision. Pour l’intégration des photos sélectionnées, un script doit également être utilisé pour récupérer les photos et effectuer la mise à jour.
7.1 Création du compte GitHub
Lors de la création de votre compte, il est préférable d’utiliser votre nom complet (avec accents) afin de faciliter le lien avec votre bio comme contributeur (voir ici). Votre nom d’utilisateur peut être celui que vous voulez, mais idéalement vous devriez spécifier votre nom complet comme identifiant. Par exemple, un nom d’utilisateur peut être frousseu, mais un nom complet serait François Rousseu. Il n’est pas nécessaire de créer le fichier .md contenant votre bio. Un membre de l’équipe de révision peut s’en charger.
7.2 Trouvez le fichier de votre espèce
La façon la plus simple pour éditer le contenu pour une espèce est d’utiliser la plateforme en ligne. En premier, il faut naviguer vers le fichier .md de votre espèce. Les espèces sont classifiées dans des dossiers par famille et par genre. Lorsque vous êtes sur le fichier de l’espèce, vous pouvez utiliser le bouton en haut à droite Edit this file (le petit icône de crayon).
7.3 Créez une image sur votre compte ( fork )
La plateforme vous proposera de créer une fork sur votre propre compte. Cette fork est en quelque sort une image des différents dossiers et fichiers qu’il y a sur le site GitHub de Flore Québec. Cette image vous permettra de travailler les comptes-rendus directement sur votre compte sans que ces modifications affectent le site principal. Lors de la création de cette image (fork), conservez les sélections par défaut et choisissez s’il y a lieu l’option Commit directly to the main branch.
Lors de l’édition d’un compte-rendu, assurez-vous que vous êtes bien sur la fork de votre compte GitHub et non sur le compte de Flore Québec (voir en haut en gauche).
7.4 Éditez le fichier .md
7.5 Enregistrez les changements (Commit changes)
Par la suite, il faudra cliquer sur le bouton vert Commit changes (en haut à droite) pour proposer les changements. Une branche (fork) sera alors créée sur votre compte GitHub à partir de laquelle vous pourrez éditer les comptes-rendus. Encore une fois, choisissez l’option Commit to the main branch s’il y a lieu.
7.6 Soumettez vos modifications
Une fois que vous êtes satisfait de votre compte-rendu, vous pouvez soumettre votre compte-rendu à l’aide du bouton Contribute. Vous aurez accès à ce bouton en allant sur la page principale de votre fork.
7.7 Créez une demande de modifications
Ce bouton vous permettra de soumettre vos modifications par l’intermédiaire d’une pull request (Create pull request) pour proposer d’intégrer les changements aux site. Ce processus peut paraître un peu complexe la première fois, mais après quelques fois, cela devrait vous paraître beaucoup plus facile. À noter que les changements que vous proposerez devront être approuvés par un membre de l’équipe de révision. Ceci permettra notamment de s’assurer de l’unformité du contenu et de repérer d’éventuelles erreurs de syntaxe markdown ou d’orthographe.
7.8 Synchronisez votre fork
Lors de vos prochaines modifications ou écritures de comptes-rendus, il est préférable de synchronizer le contenu de votre fork avec celui du site principal. Pour ce faire, vous devez utiliser le bouton Sync fork sur la page principale de votre fork. Ceci vous permettra d’intégrer les modifications récentes sur votre fork. Cette étape n’est pas essentielle, mais elle peut-être très utile si par exemple une autre personne aurait déjà écrit le compte-rendu pour l’espèce que vous souhaitez modifier.
Pour vos comptes-rendus suivants, vous pouvez directement écrire les comptes-rendus sur votre fork. L’idéal est de les soumettre au site principal au fur et à mesure pour faciliter la révision par l’équipe.
Si vous êtes un contributeur régulier, vous pourriez également obtenir les droits pour proposer ou intégrer directement vos modifications sur le site sans passer par le processus de fork (création d’une branche sur votre compte) ou de pull request. Pour toutes questions, n’hésitez pas à contacter un membre de l’équipe de révision et notamment François Rousseu.