Merge remote-tracking branch 'weblate/develop' into develop

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

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 7c480c52f049f1ec51d63d3c4a2f28e191ec275c..4bc590bde988d9cbaa1aa58e0ca75edf11fb0a81 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -7,7 +7,6 @@ Interested in contributing? Awesome!
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-
 - [Translate](#translate)
 - [Give your feedback](#give-your-feedback)
 - [Write documentation](#write-documentation)
@@ -18,8 +17,10 @@ Interested in contributing? Awesome!
   - [Server side](#server-side)
   - [Client side](#client-side)
   - [Client and server side](#client-and-server-side)
-  - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers)
-  - [Unit tests](#unit-tests)
+  - [RTL layout](#rtl-layout)
+  - [Testing](#testing)
+    - [Unit/integration tests](#unitintegration-tests)
+    - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers)
   - [Emails](#emails)
 - [Plugins & Themes](#plugins--themes)
 
@@ -125,7 +126,7 @@ You can get a complete PeerTube development setup with Gitpod, a free one-click
 
 ### Server side
 
-You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
+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:
 
@@ -140,7 +141,7 @@ restart.
 ### Client side
 
 You can find a documentation of the client code/architecture
-[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
+[here](https://docs.joinpeertube.org/contribute-architecture?id=client-code).
 
 
 To develop on the client side:
@@ -163,45 +164,22 @@ and the web server is automatically restarted.
 $ npm run dev
 ```
 
-### Testing
-
-Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves
-as expected and respect the syntax conventions. They will run upon PR submission as part of our CI, but running them beforehand yourself will get you faster feedback and save CI runner time for others.
-
-PeerTube mainly features backend and plugin tests, found in `server/tests`.
+### RTL layout
 
-#### 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):
+To test RTL layout using `ar` locale:
 
 ```
-$ sudo -u postgres createuser you_username --createdb --superuser
-$ npm run clean:server:test
+$ npm run dev -- --ar-locale
 ```
 
-Build the application and run the unit/integration tests:
-
-```
-$ npm run build -- --light
-$ npm test
-```
-
-If you just want to run 1 test (which is what you want to debug a specific test rapidly):
-
-```
-$ TS_NODE_FILES=true npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/videos/single-server.ts
-```
+### Testing
 
-While testing, you might want to display a server's logs:
+#### Unit/integration tests
 
-```
-NODE_APP_INSTANCE=1 NODE_ENV=test npm run parse-log -- --level debug | less +GF
-```
+Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves
+as expected and respect the syntax conventions. They will run upon PR submission as part of our CI, but running them beforehand yourself will get you faster feedback and save CI runner time for others.
 
-Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
-Note that only instance 2 has transcoding enabled.
+See the [dedicated documentation](/support/doc/development/tests.md) to run tests locally.
 
 #### Testing the federation of PeerTube servers
 
@@ -216,14 +194,16 @@ $ createdb -O peertube peertube_test{1,2,3}
 Build the application and flush the old tests data:
 
 ```
-$ npm run build -- --light
+$ npm run build
 $ npm run clean:server:test
 ```
 
-This will run 3 nodes:
+To run 3 nodes:
 
 ```
-$ npm run play
+$ NODE_APP_INSTANCE=1 NODE_ENV=test npm start
+$ NODE_APP_INSTANCE=2 NODE_ENV=test npm start
+$ NODE_APP_INSTANCE=3 NODE_ENV=test npm start
 ```
 
 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
@@ -240,4 +220,4 @@ To test emails with PeerTube:
 
 ## Plugins & Themes
 
-See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins
+See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins