X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=c70bc44e21ceba324f6497b5150e52c1c1049d19;hb=e1807a942f08e44775a25c0d0544cc322955466b;hp=a58efc1dda35d8768d3b9410c1dd2d89ee2712bb;hpb=1909685158e092df617e50add9e6e655b5d23cbf;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a58efc1dd..c70bc44e2 100644 --- 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 @@ -105,23 +111,55 @@ $ npm run dev ### Federation -This will run 3 nodes: +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 -To run unit tests, you need to build the application first: +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