Log typo

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

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index cbd628c25d9891b88a18f43674d11101db8c0f5e..1672ebfa9b7523eee8982f9f6cb9b32f6b6650c0 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -2,7 +2,7 @@
 
 Interested in contributing? Awesome!
 
-**Quick Links:**
+**This guide will present you the following contribution topics:**
 
   * [Translate](#translate)
   * [Give your feedback](#give-your-feedback)
@@ -55,14 +55,16 @@ before you start working on them :).
 
 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
 
-Make sure that you have followed 
-[the steps](/support/doc/dependencies.md) 
+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`
@@ -91,9 +99,15 @@ $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
 
 In dev mode, administrator username is **root** and password is **test**.
 
+### Online development
+
+You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
+
 ### Server side
 
-You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md).
+You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
 
 To develop on the server-side:
 
@@ -107,8 +121,8 @@ restart.
 
 ### Client side
 
-You can find a documentation of the server code/architecture
-[here](/support/doc/development/client/code.md).
+You can find a documentation of the client code/architecture
+[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
 
 
 To develop on the client side:
@@ -131,37 +145,7 @@ and the web server is automatically restarted.
 $ npm run dev
 ```
 
-Depending on your OS, you may face the following error :
-```
-$ [nodemon] Internal watch failed: ENOSPC: no space left on device, watch '/PeerTube/dist'
-```
-
-This is due to your system's limit on the number of files you can monitor for live-checking changes. For example, Ubuntu uses inotify and this limit is set to 8192. Then you need to change this limit :
-```
-echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
-```
-
-See more information here : https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers
-
-### Configurations for VPS
-
-If you want to develop using a Virtual Private Server, you will need to configure the url for the API and the hostname. First, you need to edit the [client/src/environments/environment.hmr.ts](client/src/environments/environment.hmr.ts) file by replacing the `localhost` in the `apiUrl` field with the address of your VPS. Thus, the [Hot Module Replacement](https://webpack.js.org/concepts/hot-module-replacement/) from Webpack will be set up for developping with live-reload.
-
-Next, you will need to edit the [config/default.yaml](config/default.yaml) file. Just replace the `localhost` with your VPS address in the following `hostname` fields :
-```
-listen:
-  hostname: 'my-vps-address.net'
-  port: 9000
-
-webserver:
-  https: false
-  hostname: 'my-vps-address.net'
-  port: 9000
-```
-
-Then, you just need to listen to `https://my-vps-address.net:3000/` in your web browser.
-
-### Federation
+### Testing the federation of PeerTube servers
 
 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 Then, we can create the databases (if they don't already exist):
@@ -174,7 +158,7 @@ $ createdb -O peertube peertube_test{1,2,3}
 Build the application and flush the old tests data:
 
 ```
-$ npm run build
+$ npm run build -- --light
 $ npm run clean:server:test
 ```
 
@@ -197,13 +181,13 @@ Then, we can create the databases (if they don't already exist):
 
 ```
 $ sudo -u postgres createuser you_username --createdb --superuser
-$ createdb -O peertube peertube_test{1,2,3,4,5,6}
+$ npm run clean:server:test
 ```
 
 Build the application and run the unit/integration tests:
 
 ```
-$ npm run build
+$ npm run build -- --light
 $ npm test
 ```