Unlisted videos are not displayed on Mastodon now

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

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index dec6a5cd03fd6f3c126818e13d0e0b17dcb4c462..3d90b70b9627b0478415ecca4bf3996a2079a9ef 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -20,11 +20,20 @@ interested in, user interface, design, decentralized architecture...
 ## Write documentation
 
 You can help to write the documentation of the REST API, code, architecture,
-demonstrations...
+demonstrations.
+
+For the REST API you can see the documentation in [/support/doc/api](/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
+
 
 ## Develop
 
-Don't hesitate to talk about features you want to develop by creating an issue
+Don't hesitate to talk about features you want to develop by creating/commenting an issue
 before you start working on them :).
 
 ### Prerequisites
@@ -35,7 +44,7 @@ to install the dependencies.
 
 Then clone the sources and install node modules:
 
-```bash
+```
 $ git clone -b master https://github.com/Chocobozzz/PeerTube
 $ cd PeerTube
 $ yarn install --pure-lockfile
@@ -46,7 +55,7 @@ Then, create a postgres database and user with the values set in the
 there, the following commands would create a new database called `peertube_dev`
 and a postgres user called `peertube` with password `peertube`:
 
-```bash
+```
 # sudo -u postgres createuser -P peertube
 Enter password for new role: peertube
 # sudo -u postgres createdb -O peertube peertube_dev
@@ -60,7 +69,7 @@ You can find a documentation of the server code/architecture [here](/support/doc
 
 To develop on the server-side:
 
-```bash
+```
 $ npm run dev:server
 ```
 
@@ -76,7 +85,7 @@ You can find a documentation of the server code/architecture
 
 To develop on the client side:
 
-```bash
+```
 $ npm run dev:client
 ```
 
@@ -88,7 +97,7 @@ reload them automatically thanks to hot module replacement.
 
 This will run 3 nodes:
 
-```bash
+```
 $ npm run clean:server:test
 $ npm run play
 ```