Relecture ou révision de contenu

En résumé

Qu'est-ce que Plan ₿ Academy ?

Pourquoi contribuer ?

Dois-je savoir comment fonctionne GitHub ?

Compte GitHubComment créer son propre compte sur GitHub ?

1. Créer un compte

• Créez un compte sur GitHub pour commencer à contribuer. Si vous souhaitez être guidé dans la manière de créer votre compte sur GitHub, nous avons également un tutoriel détaillé.

Compte GitHubComment créer son propre compte sur GitHub ?

• Vous aurez également besoin d'un compte sur l'application de messagerie Telegram.

2. Rejoindre le groupe Telegram

• Rejoignez le groupe Plan ₿ Academy Content Builder sur Telegram.

• Présentez-vous brièvement et précisez le contenu spécifique sur lequel vous souhaitez contribuer ainsi que la langue concernée, en envoyant un message dans le canal "General".
• Un membre de l’équipe créera ensuite une issue sur GitHub correspondant à votre future contribution. Vous y trouverez toutes les informations nécessaires pour commencer votre relecture.

3. Réviser et modifier le contenu via l'interface GitHub

• L’issue contient une description (cf. *A*) avec des liens vers le contenu original et le fichier à réviser.
• Si vous souhaitez prendre en charge la révision, laissez un commentaire sur l’issue (cf. *B*) pour indiquer que vous allez travailler dessus. Cela évitera toute duplication de travail.
• Cliquez sur le lien à côté du fichier à réviser (cf. *C*) pour accéder au contenu.

• Si c'est votre première contribution, GitHub vous demandera de faire un fork du dépôt source. Cliquez simplement sur le bouton.

• Ensuite, vous arriverez sur l'interface de l'Éditeur (cf. *A*), où vous pouvez voir le chemin du fichier et la branche correspondante (cf. *B*), et vous pouvez basculer entre le mode édition et le mode aperçu (cf. *C*).

4. Commit les modifications

• Vous pouvez commencer à relire le contenu et le corriger si besoin.
• Lorsque vous souhaitez arrêter votre session de révision, vous pouvez commit vos modifications, même si la révision n'est pas terminée. C'est un peu comme si vous sauvegardiez vos modifications sur GitHub.
• Cliquez sur le bouton Commit Changes....

• Ajoutez un message descriptif sur votre changement (cf. *A*).
• Ajoutez plus de contexte dans la description si nécessaire (cf. *B*).
• Cliquez sur le bouton Propose changes (cf. *C*).

• Si ce n'est pas la première fois que vous contribuez, GitHub vous proposera de créer une nouvelle branche. Il ne faut jamais effectuer de commits directement sur la branche principale dev. Si vous avez déjà effectué des commits sur une branche de travail existante, sélectionnez cette branche. Sinon, choisissez l’option Create a new branch pour en créer une nouvelle.

• Vous accéderez ensuite à une page récapitulant tous vos changements. En la faisant défiler, vous pourrez visualiser précisément les modifications apportées : les éléments supprimés apparaissent en rouge, tandis que les éléments ajoutés sont en vert.

• Si vous n'avez pas terminé votre révision et que vous souhaitez continuer votre travail plus tard, vous pouvez simplement quitter.
• Du moment que vous avez bien commit vos modifications, elles sont enregistrées sur votre fork GitHub.
• Pour reprendre votre travail, rendez-vous sur votre fork du dépôt de contenu Plan ₿ Academy via votre profil GitHub.

• Sélectionnez la branche contenant votre progression (cf. *A*), localisez votre fichier de contenu (cf. *B*), puis cliquez sur l’icône en forme de stylo pour continuer la révision.

5. Créer une PR avec la branche dédiée

• Si tout vous convient et que vous avez terminé vos modifications, vous pouvez cliquer sur le bouton vert Create Pull Request.

• Vous arriverez ensuite sur la page de la PR. Une Pull Request est une demande permettant à un contributeur de soumettre des modifications effectuées sur une branche d’un dépôt distant pour qu’elles soient examinées et éventuellement fusionnées dans la branche principale du dépôt.
• Ajoutez un titre et une courte description à votre PR. Le titre doit correspondre à celui de l’issue sur laquelle vous travaillez. Par exemple, si le titre de l’issue est [TRANSLATION] Course CYP201 - FR, utilisez ce même titre pour votre PR (cf. *A*). Dans la description, mentionnez l’issue associée en utilisant son numéro, précédé de la mention "Closes". Cela permettra de fermer automatiquement l’issue une fois la PR fusionnée (cf. *B*).
• Si tout vous semble correct, cliquez sur le bouton vert Create Pull Request (cf. *C*).

6. Règles à suivre lors de la relecture de contenu

7. Attendre la révision

• Félicitations, votre PR a été envoyée ! Vous pouvez suivre son avancement dans l'onglet Pull requests sur le dépôt GitHub de Plan ₿ Academy :

• Merci beaucoup pour votre contribution ! Après approbation, un membre de l'équipe de Plan ₿ Academy vous contactera pour vous envoyer votre récompense. Les paiements se font uniquement sur le Lightning Network.

• Si vous souhaitez recommencer, retournez à l'étape 2 et envoyez un nouveau message sur le groupe Telegram pour continuer à contribuer sur d'autres contenus. Pensez à synchroniser votre fork avant de créer une nouvelle branche de travail. Pour cela, rendez-vous sur la page d’accueil de votre fork, sélectionnez la branche principale nommée dev (cf. *A*), puis cliquez sur le bouton Sync fork (cf. *B*). Si des mises à jour sont disponibles pour votre fork, un bouton Update branch apparaîtra. Cliquez simplement dessus pour effectuer la mise à jour.

• Si vous avez des remarques, des questions ou des commentaires sur ce projet, vous pouvez envoyer un DM sur le groupe Telegram des contributeurs.