aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2020-07-10 09:39:53 +0200
committerChocobozzz <chocobozzz@cpy.re>2020-07-10 14:02:41 +0200
commit17b07dc5a2c3ac7055a0490e34b3a1a527286895 (patch)
treeedfb763e1c99a8fa3fc3e6c3bf0cf05089793e73
parentcfde28bac33c3644e1b6218eb471b675a37def60 (diff)
downloadPeerTube-17b07dc5a2c3ac7055a0490e34b3a1a527286895.tar.gz
PeerTube-17b07dc5a2c3ac7055a0490e34b3a1a527286895.tar.zst
PeerTube-17b07dc5a2c3ac7055a0490e34b3a1a527286895.zip
Update contributing guide
-rw-r--r--.github/CONTRIBUTING.md35
-rw-r--r--support/doc/api/openapi.yaml17
2 files changed, 45 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,
30demonstrations. 44demonstrations.
31 45
32For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory. 46For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory.
33Then, 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. 47Then, 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
35Some hints: 49Some 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
201Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. 215Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
202Note that only instance 2 has transcoding enabled. 216Note that only instance 2 has transcoding enabled.
203 217
218### Emails
219
220To 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
206See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins 227See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 3b381bbb5..1c5a60f6e 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1535,6 +1535,23 @@ paths:
1535 description: only list reports of a specific video channel 1535 description: only list reports of a specific video channel
1536 schema: 1536 schema:
1537 type: string 1537 type: string
1538 - name: videoIs
1539 in: query
1540 description: only list blacklisted or deleted videos
1541 schema:
1542 type: string
1543 enum:
1544 - 'deleted'
1545 - 'blacklisted'
1546 - name: filter
1547 in: query
1548 description: only list account, comment or video reports
1549 schema:
1550 type: string
1551 enum:
1552 - 'video'
1553 - 'comment'
1554 - 'account'
1538 - $ref: '#/components/parameters/start' 1555 - $ref: '#/components/parameters/start'
1539 - $ref: '#/components/parameters/count' 1556 - $ref: '#/components/parameters/count'
1540 - $ref: '#/components/parameters/abusesSort' 1557 - $ref: '#/components/parameters/abusesSort'