X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=b12e973617e963cd4e0c0069721e46b25707c974;hb=3e95b6834304ebbff7d796a6a5e096e52813bc77;hp=1672ebfa9b7523eee8982f9f6cb9b32f6b6650c0;hpb=50b4dcce56275e57fc15ade7529f5c501cad150d;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1672ebfa9..b12e97361 100644 --- 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) - * [Develop](#develop) * [Improve the website](#improve-the-website) + * [Develop](#develop) + * [Write a plugin or a theme](#plugins--themes) ## 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. -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: - * 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 @@ -194,8 +195,12 @@ $ 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. + +## Plugins & Themes + +See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins