X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=568b726a5f556baf65e60a7cb2a63736136cb473;hb=d3217560a611b94f888ecf3de93b428a7521d4de;hp=74dad738192a9e34416ff3be9ac3d976f7e42247;hpb=a2897212640d6ff09881aaf1cc49bbdf65b4918d;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 74dad7381..568b726a5 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,12 +1,19 @@
 # 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)
+  * [Improve the website](#improve-the-website)
   * [Develop](#develop)
+  * [Write a plugin or a theme](#plugins--themes)
+
+## 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 +38,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,18 +54,32 @@ before you start working on them :).
 
 ### Prerequisites
 
-First, make sure that you have followed 
-[the steps](/support/doc/dependencies.md) 
-to install the dependencies.
+First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
 
-Then clone the sources and install node modules:
+Make sure that you have followed
+[the steps](/support/doc/dependencies.md)
+to install the dependencies. You'll need to install **NodeJS 10**.
+
+Fork the github repository,
+and then clone the sources and install node modules:
 
 ```
 $ git clone https://github.com/Chocobozzz/PeerTube
+$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
 $ 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.
+
+When you create a new branch you should also tell to use your repo for upload
+not default one. To do just do:
+```
+$ git push --set-upstream me <your branch name>
+```
+
 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,11 +91,24 @@ 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).
+You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
 
 To develop on the server-side:
 
@@ -79,8 +122,8 @@ restart.
 
 ### Client side
 
-You can find a documentation of the server code/architecture
-[here](/support/doc/development/client/code.md).
+You can find a documentation of the client code/architecture
+[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
 
 
 To develop on the client side:
@@ -103,18 +146,20 @@ and the web server is automatically restarted.
 $ npm run dev
 ```
 
-### Federation
+### Testing the federation of PeerTube servers
 
-Create the tests database if they do not exist:
+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 createdb -O peertube peertube_test{1,2,3}
+$ 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 build -- --light
 $ npm run clean:server:test
 ```
 
@@ -127,18 +172,35 @@ $ 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
 
-Create the tests database if they do not exist:
+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 createdb -O peertube peertube_test{1,2,3}
+$ sudo -u postgres createuser you_username --createdb --superuser
+$ npm run clean:server:test
 ```
 
 Build the application and run the unit/integration tests:
 
 ```
-$ npm run build
+$ npm run build -- --light
 $ npm test
 ```
+
+If you just want to run 1 test:
+
+```
+$ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --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.
+
+## Plugins & Themes
+
+See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins