X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=c70bc44e21ceba324f6497b5150e52c1c1049d19;hb=9b67da3d9bc951c624f17dce7821036f8518d893;hp=74dad738192a9e34416ff3be9ac3d976f7e42247;hpb=a2897212640d6ff09881aaf1cc49bbdf65b4918d;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 74dad7381..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,10 +111,12 @@ $ npm run dev ### Federation -Create the tests database if they do not exist: +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 createdb -O peertube peertube_test{1,2,3} +$ sudo -u postgres createuser you_username --createdb +$ createdb -O peertube peertube_test{1,2,3} ``` Build the application and flush the old tests data: @@ -127,13 +135,17 @@ $ 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 the tests database if they do not exist: +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 createdb -O peertube peertube_test{1,2,3} +$ 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: @@ -142,3 +154,12 @@ 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