**This guide will present you the following contribution topics:**
- * [Translate](#translate)
- * [Give your feedback](#give-your-feedback)
- * [Write documentation](#write-documentation)
- * [Improve the website](#improve-the-website)
- * [Develop](#develop)
- * [Write a plugin or a theme](#plugins--themes)
+<!-- 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 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:
- * 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
## Develop
-Don't hesitate to talk about features you want to develop by creating/commenting an issue
-before you start working on them :).
+Always talk about features you want to develop by creating/finding and commenting the issue tackling your problem
+before you start working on it, and inform the community that you begin coding by claiming the issue.
+
+Once you are ready to show your code to ask for feedback, submit a *draft* Pull Request.
+Once you are ready for a code review before merge, submit a Pull Request. In any case, please
+link your PR to the issues it solves by using the GitHub syntax: "fixes #issue_number".
### Prerequisites
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
+1) Make sure that you have followed
[the steps](/support/doc/dependencies.md)
-to install the dependencies. You'll need to install **NodeJS 10**.
-
-Fork the github repository,
-and then clone the sources and install node modules:
-
+to install the dependencies.
+1) Install [parallel](https://www.gnu.org/software/parallel/) to be able to run tests.
+1) Fork the Github repository.
+1) Run the following commands.
```
$ git clone https://github.com/Chocobozzz/PeerTube
-$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
$ cd PeerTube
+$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
$ yarn install --pure-lockfile
```
$ npm run dev
```
-### Testing the federation of PeerTube servers
+### Testing
+
+Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves
+as expected and respect the syntax conventions. They will run upon PR submission as part of our CI, but running them beforehand yourself will get you faster feedback and save CI runner time for others.
+
+PeerTube mainly features backend and plugin tests, found in `server/tests`.
+
+#### 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
+$ npm run clean:server:test
```
-Build the application and flush the old tests data:
+Build the application and run the unit/integration tests:
```
$ npm run build -- --light
-$ npm run clean:server:test
+$ npm test
```
-This will run 3 nodes:
+If you just want to run 1 test (which is what you want to debug a specific test rapidly):
```
-$ npm run play
+$ TS_NODE_FILES=true npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/videos/single-server.ts
```
-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.
+While testing, you might want to display a server's logs:
-Instance configurations are in `config/test-{1,2,3}.yaml`.
+```
+NODE_APP_INSTANCE=1 NODE_ENV=test npm run parse-log -- --level debug | less +GF
+```
-### Unit tests
+Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
+Note that only instance 2 has transcoding enabled.
-Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
+#### 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):
```
-$ sudo -u postgres createuser you_username --createdb --superuser
-$ npm run clean:server:test
+$ sudo -u postgres createuser you_username --createdb
+$ createdb -O peertube peertube_test{1,2,3}
```
-Build the application and run the unit/integration tests:
+Build the application and flush the old tests data:
```
$ npm run build -- --light
-$ npm test
+$ npm run clean:server:test
```
-If you just want to run 1 test:
+This will run 3 nodes:
```
-$ npm run mocha -- --exit --require ts-node/register/type-check --bail server/tests/api/index.ts
+$ npm run play
```
-Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
-Note that only instance 2 has transcoding enabled.
+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`.
+
+### 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
projects / github / Chocobozzz / PeerTube.git / blobdiff