Cleanup utils helper

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

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 3d90b70b9627b0478415ecca4bf3996a2079a9ef..c70bc44e21ceba324f6497b5150e52c1c1049d19 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -4,11 +4,17 @@ Interesting in contributing? Awesome!
 
 **Quick Links:**
 
+  * [Translate](#translate)
   * [Give your feedback](#give-your-feedback)
   * [Write documentation](#write-documentation)
   * [Develop](#develop)
 
 
+## Translate
+
+You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
+
+
 ## Give your feedback
 
 You don't need to know how to code to start contributing to PeerTube! Other
@@ -45,7 +51,7 @@ to install the dependencies.
 Then clone the sources and install node modules:
 
 ```
-$ git clone -b master https://github.com/Chocobozzz/PeerTube
+$ git clone https://github.com/Chocobozzz/PeerTube
 $ cd PeerTube
 $ yarn install --pure-lockfile
 ```
@@ -75,7 +81,7 @@ $ npm run dev:server
 
 Then, the server will listen on `localhost:9000`. When server source files
 change, these are automatically recompiled and the server will automatically
-restart. Server is in `TEST` mode so it will run requests between instances more quickly.
+restart.
 
 ### Client side
 
@@ -93,14 +99,67 @@ The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 Client files are automatically compiled on change, and the web browser will
 reload them automatically thanks to hot module replacement.
 
-### Test federation
+### Client and server side
 
-This will run 3 nodes:
+The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
+File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
+and the web server is automatically restarted.
+
+```
+$ npm run dev
+```
+
+### Federation
+
+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):
+
+```
+$ sudo -u postgres createuser you_username --createdb
+$ createdb -O peertube peertube_test{1,2,3}
+```
+
+Build the application and flush the old tests data:
 
 ```
+$ npm run build
 $ npm run clean:server:test
+```
+
+This will run 3 nodes:
+
+```
 $ npm run play
 ```
 
 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
 with the `root` as username and `test{1,2,3}` for the password.
+
+Instance configurations are in `config/test-{1,2,3}.yaml`.
+
+### Unit tests
+
+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):
+
+```
+$ sudo -u postgres createuser you_username --createdb --superuser
+$ createdb -O peertube peertube_test{1,2,3,4,5,6}
+```
+
+Build the application and run the unit/integration tests:
+
+```
+$ npm run build
+$ npm test
+```
+
+If you just want to run 1 test:
+
+```
+$ npm run mocha -- --exit --require ts-node/register/type-check --bail server/tests/api/index.ts
+```
+
+Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
+Note that only instance 2 has transcoding enabled.
\ No newline at end of file