Update contributing to use multiple remote. (#1902)

[github/Chocobozzz/PeerTube.git] / .github / CONTRIBUTING.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index b880270421842bbd368458f4518bfbd99866c09b..bbf06c87fb2bb2c6145c1fd55dff7cc6a3c8538c 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -59,10 +59,12 @@ Make sure that you have followed
 [the steps](/support/doc/dependencies.md)
 to install the dependencies.
 
-Then clone the sources and install node modules:
+Fork the github repository,
+and then clone the sources and install node modules:
 
 ```
 $ git clone https://github.com/Chocobozzz/PeerTube
+$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
 $ cd PeerTube
 $ yarn install --pure-lockfile
 ```
@@ -71,6 +73,12 @@ Note that development is done on the `develop` branch. If you want to hack on
 Peertube, you should switch to that branch. Also note that you have to repeat
 the `yarn install --pure-lockfile` command.
 
+When you create a new branch you should also tell to use your repo for upload
+not default one. To do just do:
+```
+$ git push --set-upstream me <your branch name>
+```
+
 Then, create a postgres database and user with the values set in the
 `config/default.yaml` file. For instance, if you do not change the values
 there, the following commands would create a new database called `peertube_dev`
@@ -113,7 +121,7 @@ restart.
 
 ### Client side
 
-You can find a documentation of the server code/architecture
+You can find a documentation of the client code/architecture
 [here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).