diff options
| author | Chocobozzz <me@florianbigard.com> | 2020-07-10 09:39:53 +0200 |
|---|---|---|
| committer | Chocobozzz <chocobozzz@cpy.re> | 2020-07-10 14:02:41 +0200 |
| commit | 17b07dc5a2c3ac7055a0490e34b3a1a527286895 (patch) | |
| tree | edfb763e1c99a8fa3fc3e6c3bf0cf05089793e73 /.github/CONTRIBUTING.md | |
| parent | cfde28bac33c3644e1b6218eb471b675a37def60 (diff) | |
| download | PeerTube-17b07dc5a2c3ac7055a0490e34b3a1a527286895.tar.gz PeerTube-17b07dc5a2c3ac7055a0490e34b3a1a527286895.tar.zst PeerTube-17b07dc5a2c3ac7055a0490e34b3a1a527286895.zip | |
Update contributing guide
Diffstat (limited to '.github/CONTRIBUTING.md')
| -rw-r--r-- | .github/CONTRIBUTING.md | 35 |
1 files changed, 28 insertions, 7 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b12e97361..704b22b8b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md | |||
| @@ -4,12 +4,26 @@ Interested in contributing? Awesome! | |||
| 4 | 4 | ||
| 5 | **This guide will present you the following contribution topics:** | 5 | **This guide will present you the following contribution topics:** |
| 6 | 6 | ||
| 7 | * [Translate](#translate) | 7 | <!-- START doctoc generated TOC please keep comment here to allow auto update --> |
| 8 | * [Give your feedback](#give-your-feedback) | 8 | <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
| 9 | * [Write documentation](#write-documentation) | 9 | |
| 10 | * [Improve the website](#improve-the-website) | 10 | |
| 11 | * [Develop](#develop) | 11 | - [Translate](#translate) |
| 12 | * [Write a plugin or a theme](#plugins--themes) | 12 | - [Give your feedback](#give-your-feedback) |
| 13 | - [Write documentation](#write-documentation) | ||
| 14 | - [Improve the website](#improve-the-website) | ||
| 15 | - [Develop](#develop) | ||
| 16 | - [Prerequisites](#prerequisites) | ||
| 17 | - [Online development](#online-development) | ||
| 18 | - [Server side](#server-side) | ||
| 19 | - [Client side](#client-side) | ||
| 20 | - [Client and server side](#client-and-server-side) | ||
| 21 | - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers) | ||
| 22 | - [Unit tests](#unit-tests) | ||
| 23 | - [Emails](#emails) | ||
| 24 | - [Plugins & Themes](#plugins--themes) | ||
| 25 | |||
| 26 | <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
| 13 | 27 | ||
| 14 | ## Translate | 28 | ## Translate |
| 15 | 29 | ||
| @@ -30,7 +44,7 @@ You can help to write the documentation of the REST API, code, architecture, | |||
| 30 | demonstrations. | 44 | demonstrations. |
| 31 | 45 | ||
| 32 | For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory. | 46 | For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory. |
| 33 | 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. | 47 | 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. |
| 34 | 48 | ||
| 35 | Some hints: | 49 | Some hints: |
| 36 | * Routes are defined in [/server/controllers/](https://github.com/Chocobozzz/PeerTube/tree/develop/server/controllers) directory | 50 | * Routes are defined in [/server/controllers/](https://github.com/Chocobozzz/PeerTube/tree/develop/server/controllers) directory |
| @@ -201,6 +215,13 @@ $ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail | |||
| 201 | Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. | 215 | Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. |
| 202 | Note that only instance 2 has transcoding enabled. | 216 | Note that only instance 2 has transcoding enabled. |
| 203 | 217 | ||
| 218 | ### Emails | ||
| 219 | |||
| 220 | To test emails with PeerTube: | ||
| 221 | |||
| 222 | * Run [mailslurper](http://mailslurper.com/) | ||
| 223 | * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=test npm start` | ||
| 224 | |||
| 204 | ## Plugins & Themes | 225 | ## Plugins & Themes |
| 205 | 226 | ||
| 206 | See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins | 227 | See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins |