X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=6d095cc474ded3ae74710eed53b478a2e84d343c;hb=3f6b6a565dc98a658ec9d8f697252788c0faa46d;hp=d057cd3f345ab9ffd0bbfa318522a39851d45b34;hpb=6d492e562cdc80d986323e9b5ee14953d3956e18;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d057cd3f3..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,10 +146,12 @@ $ 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): ``` @@ -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