Don't rely on youtube for tests

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

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index c70bc44e21ceba324f6497b5150e52c1c1049d19..704b22b8b52b86048253b030bd6c0e4118a48fc3 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,15 +1,30 @@
 # Welcome to the contributing guide for PeerTube
 
 # Welcome to the contributing guide for PeerTube
 

-Interesting in contributing? Awesome!
+Interested in contributing? Awesome!

 
 

-**Quick Links:**
+**This guide will present you the following contribution topics:**

 
 

-  * [Translate](#translate)
-  * [Give your feedback](#give-your-feedback)
-  * [Write documentation](#write-documentation)
-  * [Develop](#develop)
+<!-- 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)
+- [Improve the website](#improve-the-website)
+- [Develop](#develop)
+  - [Prerequisites](#prerequisites)
+  - [Online development](#online-development)
+  - [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)
+  - [Emails](#emails)
+- [Plugins & Themes](#plugins--themes)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+

 ## Translate
 
 You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
 ## Translate
 
 You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.


@@ -28,13 +43,22 @@ interested in, user interface, design, decentralized architecture...
 You can help to write the documentation of the REST API, code, architecture,
 demonstrations.
 
 You can help to write the documentation of the REST API, code, architecture,
 demonstrations.
 

-For the REST API you can see the documentation in [/support/doc/api](/support/doc/api) directory.
-Then, you can just open the `openapi.yaml` file in a special editor like [http://editor.swagger.io/](http://editor.swagger.io/) to easily see and edit the documentation.
+For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory.
+Then, you can just open the `openapi.yaml` file in a special editor like [http://editor.swagger.io/](http://editor.swagger.io/) to easily see and edit the documentation. You can also use [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) and run `redoc-cli serve --watch support/doc/api/openapi.yaml` to see the final result.

 
 Some hints:
 
 Some hints:

- * Routes are defined in [/server/controllers/](/server/controllers/) directory
- * Parameters validators are defined in [/server/middlewares/validators](/server/middlewares/validators) directory
- * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory
+ * Routes are defined in [/server/controllers/](https://github.com/Chocobozzz/PeerTube/tree/develop/server/controllers) directory
+ * Parameters validators are defined in [/server/middlewares/validators](https://github.com/Chocobozzz/PeerTube/tree/develop/server/middlewares/validators) directory
+ * Models sent/received by the controllers are defined in [/shared/models](https://github.com/Chocobozzz/PeerTube/tree/develop/shared/models) directory
+
+
+## Improve the website
+
+PeerTube's website is [joinpeertube.org](https://joinpeertube.org), where people can learn about the project and how it works – note that it is not a PeerTube instance, but rather the project's homepage.
+
+You can help us improve it too!
+
+It is not hosted on GitHub but on [Framasoft](https://framasoft.org/)'s own [GitLab](https://about.gitlab.com/) instance, [FramaGit](https://framagit.org): https://framagit.org/framasoft/peertube/joinpeertube

 
 
 ## Develop
 
 
 ## Develop


@@ -44,18 +68,32 @@ before you start working on them :).
 
 ### Prerequisites
 
 
 ### Prerequisites
 

-First, make sure that you have followed 
-[the steps](/support/doc/dependencies.md) 
+First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
+
+Make sure that you have followed
+[the steps](/support/doc/dependencies.md)

 to install the dependencies.
 
 to install the dependencies.
 

-Then clone the sources and install node modules:
+Fork the github repository,
+and then clone the sources and install node modules:

 
 ```
 $ git clone https://github.com/Chocobozzz/PeerTube
 
 ```
 $ git clone https://github.com/Chocobozzz/PeerTube

+$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git

 $ cd PeerTube
 $ yarn install --pure-lockfile
 ```
 
 $ 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.
+
+When you create a new branch you should also tell to use your repo for upload
+not default one. To do just do:
+```
+$ git push --set-upstream me <your branch name>
+```
+

 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`
 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`


@@ -67,11 +105,24 @@ Enter password for new role: peertube
 # sudo -u postgres createdb -O peertube peertube_dev
 ```
 
 # 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**.
 
 In dev mode, administrator username is **root** and password is **test**.
 

+### Online development
+
+You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
+

 ### Server side
 
 ### Server side
 

-You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md).
+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:
 
 
 To develop on the server-side:
 


@@ -85,8 +136,8 @@ restart.
 
 ### Client side
 
 
 ### Client side
 

-You can find a documentation of the server code/architecture
-[here](/support/doc/development/client/code.md).
+You can find a documentation of the client code/architecture
+[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).

 
 
 To develop on the client side:
 
 
 To develop on the client side:


@@ -109,7 +160,7 @@ and the web server is automatically restarted.
 $ npm run dev
 ```
 
 $ npm run dev
 ```
 

-### Federation
+### Testing the federation of PeerTube servers

 
 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):
 
 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):


@@ -122,7 +173,7 @@ $ createdb -O peertube peertube_test{1,2,3}
 Build the application and flush the old tests data:
 
 ```
 Build the application and flush the old tests data:
 
 ```

-$ npm run build
+$ npm run build -- --light

 $ npm run clean:server:test
 ```
 
 $ npm run clean:server:test
 ```
 


@@ -145,21 +196,32 @@ Then, we can create the databases (if they don't already exist):
 
 ```
 $ sudo -u postgres createuser you_username --createdb --superuser
 
 ```
 $ sudo -u postgres createuser you_username --createdb --superuser

-$ createdb -O peertube peertube_test{1,2,3,4,5,6}
+$ npm run clean:server:test

 ```
 
 Build the application and run the unit/integration tests:
 
 ```
 ```
 
 Build the application and run the unit/integration tests:
 
 ```

-$ npm run build
+$ npm run build -- --light

 $ npm test
 ```
 
 If you just want to run 1 test:
 
 ```
 $ 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
+$ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/index.ts

 ```
 
 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
 ```
 
 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
+Note that only instance 2 has transcoding enabled.
+
+### Emails
+
+To test emails with PeerTube:
+
+ * Run [mailslurper](http://mailslurper.com/)
+ * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=test npm start`
+
+## Plugins & Themes
+
+See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins