X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=b3847b8d742b8d6504f0f9665cfbf2b87b99e6f2;hb=a18f275d302bbd95443c258b8d92f6dfd8eb1653;hp=a58efc1dda35d8768d3b9410c1dd2d89ee2712bb;hpb=1909685158e092df617e50add9e6e655b5d23cbf;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index a58efc1dd..b3847b8d7 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,12 +1,20 @@
 # Welcome to the contributing guide for PeerTube
 
-Interesting in contributing? Awesome!
+Interested in contributing? Awesome!
 
-**Quick Links:**
+**This guide will present you the following contribution topics:**
 
+  * [Translate](#translate)
   * [Give your feedback](#give-your-feedback)
   * [Write documentation](#write-documentation)
   * [Develop](#develop)
+  * [Improve the website](#improve-the-website)
+  * [Troubleshooting](#troubleshooting)
+  * [Tutorials](#tutorials)
+
+## Translate
+
+You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
 
 
 ## Give your feedback
@@ -31,6 +39,15 @@ Some hints:
  * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory
 
 
+## Improve the website
+
+PeerTube's website is [joinpeertube.org](https://joinpeertube.org), where people can learn about the project and how it works – note that it is not a PeerTube instance, but rather the project's homepage.
+
+You can help us improve it too!
+
+It is not hosted on GitHub but on [Framasoft](https://framasoft.org/)'s own [GitLab](https://about.gitlab.com/) instance, [FramaGit](https://framagit.org): https://framagit.org/framasoft/peertube/joinpeertube
+
+
 ## Develop
 
 Don't hesitate to talk about features you want to develop by creating/commenting an issue
@@ -38,8 +55,10 @@ before you start working on them :).
 
 ### Prerequisites
 
-First, make sure that you have followed 
-[the steps](/support/doc/dependencies.md) 
+First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
+
+Make sure that you have followed
+[the steps](/support/doc/dependencies.md)
 to install the dependencies.
 
 Then clone the sources and install node modules:
@@ -50,6 +69,10 @@ $ cd PeerTube
 $ yarn install --pure-lockfile
 ```
 
+Note that development is done on the `develop` branch. If you want to hack on
+Peertube, you should switch to that branch. Also note that you have to repeat
+the `yarn install --pure-lockfile` command.
+
 Then, create a postgres database and user with the values set in the
 `config/default.yaml` file. For instance, if you do not change the values
 there, the following commands would create a new database called `peertube_dev`
@@ -61,8 +84,21 @@ Enter password for new role: peertube
 # sudo -u postgres createdb -O peertube peertube_dev
 ```
 
+Then enable extensions PeerTube needs:
+
+```
+$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
+$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
+```
+
 In dev mode, administrator username is **root** and password is **test**.
 
+### Online development
+
+You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
+
 ### Server side
 
 You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md).
@@ -103,25 +139,65 @@ and the web server is automatically restarted.
 $ npm run dev
 ```
 
-### Federation
+### Testing the federation of PeerTube servers
 
-This will run 3 nodes:
+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):
 
 ```
-$ npm run build
+$ 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 -- --light
 $ 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.
 
+Instance configurations are in `config/test-{1,2,3}.yaml`.
 
 ### Unit tests
 
-To run unit tests, you need to build the application first:
+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
+```
+
+Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
+Note that only instance 2 has transcoding enabled.
+
+### Troubleshooting
+
+Please check out the issues and [list of common errors](https://docs.joinpeertube.org/lang/en/devdocs/troubleshooting.html).
+
+### Tutorials
+
+Please check out the related section in the [development documentation](https://docs.joinpeertube.org/lang/en/devdocs/index.html#tutorials). Contribute tutorials at [framagit.org/framasoft/peertube/documentation](https://framagit.org/framasoft/peertube/documentation).