Le but de ce tutoriel est de vous montrer comment contribuer à ce repo git en utilisant github.
Vous avez une version de ce tutoriel en ligne de commande => CONTRIBUTING.md
Le but de ce tutoriel est de vous montrez comment utiliser github afin d'automatiser les comandes du tutoriel ci-dessus et que le "contributing" soit accessible à tous, même ceux qui ont un peut de mal avec git.
- Compte github avec une adresse e-mail vérifiée
- Avoir lu les Markdown afin d'écrire un beau tutoriel.
Il vous est vivement conseiller de rédiger votre tutoriel dans un fichier dans votre afs en utilisant notamment un logiciel tel que VIM ou EMACS pour la rédaction, ainsi vous pourrez sauvegarder vos modifications et mettre en pause votre rédaction.
Une fois votre tutoriel écrit, il vous faut l'ajouter sur ce repo.
Pour ce faire, veuillez aller dans le dossier dans lequel votre tutoriel serait le plus approprié d'aller.
Si aucun dossier ne correspond à ce que vous souhaitez faire, vous pourrez ajouter votre fichier dans le dossier "unclassed", et un modérateur s'occupera de la création du dossier pour votre tutoriel dans l'endroit approprié.
Ici je suis en train d'écrire un tutoriel sur "comment écrire un tutoriel", donc je me place à la racine de ce repo puis je clique sur "Create new file" :
Puis ensuite votre nom de fichier dois respecter les balises : [FR] si vous écrivez un tutoriel en français et [ENG] si vous écrivez un tutoriel en anglais. ATTENTION : ne pas oublier de mettre l'extension ".md" à la fin de votre fichier
Ensuite il vous suffit de copier coller votre tutoriel dans la case du dessous.
Pour faire un copier-coller depuis i3, il vous suffit de faire la commande cat "nom du fichier". Puis ensuite de séléctionner le
contenu du fichier puis faire Ctrl+Alt+c pour copier puis Shift+Insert pour coller.
Atention, n'oubliez pas de signer votre tutoriel : Comment signer son tutoriel
Vous devriez obtenir ça :
Une fois cela fait, il vous suffit de remplir les champs du dessous en donnant un titre à votre commit et en expliquant rapidement pourquoi il est nécéssaire :
Une fois cela fait, il vous suffit de cliquer sur le bouton "Propose new file", vous allez être redirigé vers un autre menu puis il vous suffira de cliquer sur "Create pull request" puis encore une fois sur "Create pull request" et là ce sera bon, vous n'aurez plus qu'à attendre qu'un modérateur valide votre pull request et l'ajoute sur le repo.
Vous pouvez contribuer à un tutoriel pour diverses raisons : signaler une quelconque erreur, corriger des fautes d'orthographes, ajouter des images, ajouter des précisions etc.
Pour ce faire, vous pouvez modifier directement le fichier sur Github en ouvrant le fichier à modifier puis en cliquant sur le petit crayon :
Il vous suffit de modifier directement le fichier et ensuite d'en proposer le commit. Dans ce commit vous devrez écrire en quoi vos modifications sont judicieuses ; pour ensuite être validé par l'équipe de modérateurs avant d'être mis en ligne.
Pour la suite des opérations, c'est pareil que pour la création, il vous suffira de cliquer sur : "Commit changes", puis "Create pull request" puis encore une fois "Create pull request".
Git étant un outil qui nous permet de faire du "versionning", si un commit ne plaît pas à l'auteur(e) du post ou "casse tout", on pourra toujours annuler les éventuelles modifications.
Après avoir contribué au tutoriel de quelqu'un, vous pouvez vous ajouter dans la liste des Contributeurs. Cette liste est juste en dessous de celle des auteurs, à la fin du fichier. Cette liste doit avoir le format suivant :
- nicolas.went / 2022
La signature doit avoir le même format que pour les auteurs, je vous invite donc à consulter : [FR] Comment signer son tutoriel.
- nicolas.went / 2022 / [email protected] / Lockface77#8305 / délegué GRB1
- iyed.jaziri / 2022 / [email protected]