Update translations

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

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index d796aeac6011cebf97f6e2090a94c8867df73ff7..b12e973617e963cd4e0c0069721e46b25707c974 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -7,8 +7,9 @@ Interested in contributing? Awesome!
   * [Translate](#translate)
   * [Give your feedback](#give-your-feedback)
   * [Write documentation](#write-documentation)
   * [Translate](#translate)
   * [Give your feedback](#give-your-feedback)
   * [Write documentation](#write-documentation)

-  * [Develop](#develop)

   * [Improve the website](#improve-the-website)
   * [Improve the website](#improve-the-website)

+  * [Develop](#develop)
+  * [Write a plugin or a theme](#plugins--themes)

 
 ## Translate
 
 
 ## Translate
 


@@ -28,13 +29,13 @@ 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.
+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.
 
 Some hints:
 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.
 
 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
 
 
 ## Improve the website


@@ -63,7 +64,8 @@ Fork the github repository,
 and then clone the sources and install node modules:
 
 ```
 and then clone the sources and install node modules:
 
 ```

-$ git clone https://github.com/YOUR_GITHUB_USERNAME/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
 ```


@@ -72,6 +74,12 @@ 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.
 
 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`


@@ -114,7 +122,7 @@ restart.
 
 ### Client side
 
 
 ### Client side
 

-You can find a documentation of the server code/architecture
+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).
 
 


@@ -174,21 +182,25 @@ 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`.
 Note that only instance 2 has transcoding enabled.
 ```
 
 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
 Note that only instance 2 has transcoding enabled.

+
+## Plugins & Themes
+
+See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins