<!-- 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)
- [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)
+ - [RTL layout](#rtl-layout)
+ - [Testing](#testing)
+ - [Unit/integration tests](#unitintegration-tests)
+ - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers)
- [Emails](#emails)
- [Plugins & Themes](#plugins--themes)
## 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.
-
-Fork the github repository,
-and then clone the sources and install node modules:
-
+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
```
### Server side
-You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
+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:
### Client side
You can find a documentation of the client code/architecture
-[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
+[here](https://docs.joinpeertube.org/contribute-architecture?id=client-code).
To develop on the client side:
$ npm run dev
```
-### Testing the federation of PeerTube servers
+### RTL layout
-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):
+To test RTL layout using `ar` locale:
```
-$ sudo -u postgres createuser you_username --createdb
-$ createdb -O peertube peertube_test{1,2,3}
+$ npm run dev -- --ar-locale
```
-Build the application and flush the old tests data:
+### Testing
-```
-$ npm run build -- --light
-$ npm run clean:server:test
-```
+#### Unit/integration tests
-This will run 3 nodes:
+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.
-```
-$ npm run play
-```
+See the [dedicated documentation](/support/doc/development/tests.md) to run tests locally.
-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
+#### 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 build
+$ npm run clean:server:test
```
-If you just want to run 1 test:
+To run 3 nodes:
```
-$ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/index.ts
+$ NODE_APP_INSTANCE=1 NODE_ENV=test npm start
+$ NODE_APP_INSTANCE=2 NODE_ENV=test npm start
+$ NODE_APP_INSTANCE=3 NODE_ENV=test npm start
```
-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
## Plugins & Themes
-See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins
+See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins
projects / github / Chocobozzz / PeerTube.git / blobdiff