From 7acc54846d3fa56551ecedb873fdd0ec6c052e22 Mon Sep 17 00:00:00 2001
From: John Livingston <git@john-livingston.fr>
Date: Mon, 6 Dec 2021 15:14:47 +0100
Subject: [PATCH] Update contributing documentation.

---
 CONTRIBUTING.fr.md | 20 +++++++++++++++++++-
 CONTRIBUTING.md    | 20 +++++++++++++++++++-
 2 files changed, 38 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.fr.md b/CONTRIBUTING.fr.md
index 857439b8..4e9808df 100644
--- a/CONTRIBUTING.fr.md
+++ b/CONTRIBUTING.fr.md
@@ -34,7 +34,25 @@ Toujours annoncer les fonctionnalités sur lesquelles vous voulez travailler en
 
 Merci d'utiliser la branche `develop`. La branche `main` est réservée aux versions publiées, pour que la documentation affichée reste synchronisée avec la version publiée du plugin.
 
-Pour mettre à jour votre dépôt, utilisez la commande `git pull --recurse-submodules`, car il y a des sous-modules dans le dossier `vendor`.
+Pour clôner le dépot :
+
+```bash
+# Cloner le dépot
+git clone https://github.com/JohnXLivingston/peertube-plugin-livechat.git
+# Passer sur la branche develop
+git checkout develop
+# Initialiser les sous-modules. Cette commande est à refaire si jamais la version d'un l'un des sous-module change.
+git submodule update --init --recursive
+
+# Si vous avez un fork du dépot, ajoutez le en remote (exemple) :
+git remote add me git@github.com:MON_COMPTE_GITHUB/peertube-plugin-livechat.git
+
+# Créez une branche locale pour vos développements et placez vous dessus (exemple) :
+git checkout mon_developpement # NB: si un ticket y est associé, utilisé le nom fix_1234 (où 1234 est le numéro du ticket)
+# Pour proposer vos modifications, poussez votre branche sur votre dépot (exemple) :
+git push --set-upstream me mon_developpement
+# Rendez-vous ensuite sur votre dépot github avec votre navigateur web pour proposer la Pull Request (voir les instructions complémentaires ci-dessous)
+```
 
 Quand vous êtes prêt⋅e à montrer votre code pour avoir un retour, soumettez une Pull Request *draft*.
 Quand vous êtes prêt⋅e pour une relecture de code avant merge, soumettez une Pull Request. Dans tous les cas, merci de lier votre Pull Request au ticket concerné en utilisant la syntax de GitHub : «fixes #issue_number».
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9382302c..56fb79f3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -37,7 +37,25 @@ before you start working on it, and inform the community that you begin coding b
 
 Please use the `develop` branch. The `main` branch is reserved to released versions of the plugin, so that the documentation is always synchronized with the released version of the plugin.
 
-For updating your repository, use `git pull --recurse-submodules`, as there are submodules in the `vendor` folder.
+To clone the repository:
+
+```bash
+# Clone the repository
+git clone https://github.com/JohnXLivingston/peertube-plugin-livechat.git
+# Checkout the develop branch
+git checkout develop
+# Initialize the submodules. This command must be run again if any submodules' version changes.
+git submodule update --init --recursive
+
+# If you have a fork from the repository, add it as remote (example):
+git remote add me git@github.com:MY_GITHUB_ACCOUNT/peertube-plugin-livechat.git
+
+# Create a local branch for you developments, and checkout it (example):
+git checkout my_development # Note: if an issue is associated, use fix_1234 as your branch name (where 1234 is the issue's number)
+# To propose your modifications, push your branch to your repository (example):
+git push --set-upstream me my_development
+# Then go to your github repository with your web browser to propose the Pull Request (see additional instructions below)
+```
 
 Once you are ready to show your code to ask for feedback, submit a *draft* Pull Request.
 Once you are ready for a code review before merge, submit a Pull Request. In any case, please