Add ability to update the user display name/description

[oweals/peertube.git] / .github / CONTRIBUTING.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 2b90d94a249ab88e333051a3321c88aa215cf13c..d057cd3f345ab9ffd0bbfa318522a39851d45b34 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,
 ## 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
 
 
 ## 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
 before you start working on them :).
 
 ### Prerequisites


@@ -36,7 +45,7 @@ to install the dependencies.
 Then clone the sources and install node modules:
 
 ```
 Then clone the sources and install node modules:
 
 ```

-$ git clone -b master https://github.com/Chocobozzz/PeerTube
+$ git clone https://github.com/Chocobozzz/PeerTube

 $ cd PeerTube
 $ yarn install --pure-lockfile
 ```
 $ cd PeerTube
 $ yarn install --pure-lockfile
 ```


@@ -66,7 +75,7 @@ $ npm run dev:server
 
 Then, the server will listen on `localhost:9000`. When server source files
 change, these are automatically recompiled and the server will automatically
 
 Then, the server will listen on `localhost:9000`. When server source files
 change, these are automatically recompiled and the server will automatically

-restart. Server is in `TEST` mode so it will run requests between instances more quickly.
+restart.

 
 ### Client side
 
 
 ### Client side
 


@@ -84,14 +93,62 @@ The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 Client files are automatically compiled on change, and the web browser will
 reload them automatically thanks to hot module replacement.
 
 Client files are automatically compiled on change, and the web browser will
 reload them automatically thanks to hot module replacement.
 

-### Test federation
+### Client and server side

 
 

-This will run 3 nodes:
+The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
+File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
+and the web server is automatically restarted.

 
 ```
 
 ```

+$ npm run dev
+```
+
+### Federation
+
+Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
+Then, we can create the databases (if they don't already exist):
+
+```
+$ sudo -u postgres createuser you_username --createdb
+$ createdb -O peertube peertube_test{1,2,3}
+```
+
+Build the application and flush the old tests data:
+
+```
+$ npm run build

 $ npm run clean:server:test
 $ npm run clean:server:test

+```
+
+This will run 3 nodes:
+
+```

 $ npm run play
 ```
 
 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
 with the `root` as username and `test{1,2,3}` for the password.
 $ npm run play
 ```
 
 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
 with the `root` as username and `test{1,2,3}` for the password.

+
+
+### Unit tests
+
+Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
+Then, we can create the databases (if they don't already exist):
+
+```
+$ sudo -u postgres createuser you_username --createdb --superuser
+$ createdb -O peertube peertube_test{1,2,3,4,5,6}
+```
+
+Build the application and run the unit/integration tests:
+
+```
+$ npm run build
+$ 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
+```