X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=6d095cc474ded3ae74710eed53b478a2e84d343c;hb=46ae6f67249dea59176488ad1775f80109b8b8db;hp=3c8e6413c722fd3aa9b2252f38a51137d248d2a6;hpb=0db1a226507a39b0a663e3e63f04851836a44d5a;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3c8e6413c..6d095cc47 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 @@ -50,6 +56,10 @@ $ cd PeerTube $ yarn install --pure-lockfile ``` +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. + 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` @@ -61,6 +71,13 @@ Enter password for new role: peertube # sudo -u postgres createdb -O peertube peertube_dev ``` +Then enable extensions PeerTube needs: + +``` +$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev +$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev +``` + In dev mode, administrator username is **root** and password is **test**. ### Server side @@ -129,15 +146,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 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} +$ 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: @@ -152,3 +171,6 @@ 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