.github/CONTRIBUTING.md

   1 # Welcome to the contributing guide for PeerTube
   2
   3 Interested in contributing? Awesome!
   4
   5 **This guide will present you the following contribution topics:**
   6
   7 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
   8 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
   9
  10 - [Translate](#translate)
  11 - [Give your feedback](#give-your-feedback)
  12 - [Write documentation](#write-documentation)
  13 - [Improve the website](#improve-the-website)
  14 - [Develop](#develop)
  15   - [Prerequisites](#prerequisites)
  16   - [Online development](#online-development)
  17   - [Server side](#server-side)
  18   - [Client side](#client-side)
  19   - [Client and server side](#client-and-server-side)
  20   - [RTL layout](#rtl-layout)
  21   - [Testing](#testing)
  22     - [Unit/integration tests](#unitintegration-tests)
  23     - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers)
  24   - [Emails](#emails)
  25 - [Plugins & Themes](#plugins--themes)
  26
  27 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
  28
  29 ## Translate
  30
  31 You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
  32
  33
  34 ## Give your feedback
  35
  36 You don't need to know how to code to start contributing to PeerTube! Other
  37 contributions are very valuable too, among which: you can test the software and
  38 report bugs, you can give feedback on potential bugs, features that you are
  39 interested in, user interface, design, decentralized architecture...
  40
  41
  42 ## Write documentation
  43
  44 You can help to write the documentation of the REST API, code, architecture,
  45 demonstrations.
  46
  47 For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory.
  48 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. 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.
  49
  50 Some hints:
  51  * Routes are defined in [/server/controllers/](https://github.com/Chocobozzz/PeerTube/tree/develop/server/controllers) directory
  52  * Parameters validators are defined in [/server/middlewares/validators](https://github.com/Chocobozzz/PeerTube/tree/develop/server/middlewares/validators) directory
  53  * Models sent/received by the controllers are defined in [/shared/models](https://github.com/Chocobozzz/PeerTube/tree/develop/shared/models) directory
  54
  55
  56 ## Improve the website
  57
  58 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.
  59
  60 You can help us improve it too!
  61
  62 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
  63
  64
  65 ## Develop
  66
  67 Always talk about features you want to develop by creating/finding and commenting the issue tackling your problem
  68 before you start working on it, and inform the community that you begin coding by claiming the issue.
  69
  70 Once you are ready to show your code to ask for feedback, submit a *draft* Pull Request.
  71 Once you are ready for a code review before merge, submit a Pull Request. In any case, please
  72 link your PR to the issues it solves by using the GitHub syntax: "fixes #issue_number".
  73
  74 ### Prerequisites
  75
  76 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
  77
  78 1) Make sure that you have followed
  79 [the steps](/support/doc/dependencies.md)
  80 to install the dependencies.
  81 1) Install [parallel](https://www.gnu.org/software/parallel/) to be able to run tests.
  82 1) Fork the Github repository.
  83 1) Run the following commands.
  84 ```
  85 $ git clone https://github.com/Chocobozzz/PeerTube
  86 $ cd PeerTube
  87 $ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
  88 $ yarn install --pure-lockfile
  89 ```
  90
  91 Note that development is done on the `develop` branch. If you want to hack on
  92 Peertube, you should switch to that branch. Also note that you have to repeat
  93 the `yarn install --pure-lockfile` command.
  94
  95 When you create a new branch you should also tell to use your repo for upload
  96 not default one. To do just do:
  97 ```
  98 $ git push --set-upstream me <your branch name>
  99 ```
 100
 101 Then, create a postgres database and user with the values set in the
 102 `config/default.yaml` file. For instance, if you do not change the values
 103 there, the following commands would create a new database called `peertube_dev`
 104 and a postgres user called `peertube` with password `peertube`:
 105
 106 ```
 107 # sudo -u postgres createuser -P peertube
 108 Enter password for new role: peertube
 109 # sudo -u postgres createdb -O peertube peertube_dev
 110 ```
 111
 112 Then enable extensions PeerTube needs:
 113
 114 ```
 115 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
 116 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
 117 ```
 118
 119 Peertube also requires a running redis server, no special setup is needed for
 120 this.
 121
 122 In dev mode, administrator username is **root** and password is **test**.
 123
 124 ### Online development
 125
 126 You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
 127
 128 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
 129
 130 ### Server side
 131
 132 You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/contribute-architecture?id=server-code).
 133
 134 To develop on the server-side:
 135
 136 ```
 137 $ npm run dev:server
 138 ```
 139
 140 Then, the server will listen on `localhost:9000`. When server source files
 141 change, these are automatically recompiled and the server will automatically
 142 restart.
 143
 144 ### Client side
 145
 146 You can find a documentation of the client code/architecture
 147 [here](https://docs.joinpeertube.org/contribute-architecture?id=client-code).
 148
 149
 150 To develop on the client side:
 151
 152 ```
 153 $ npm run dev:client
 154 ```
 155
 156 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 157 Client files are automatically compiled on change, and the web browser will
 158 reload them automatically thanks to hot module replacement.
 159
 160 ### Client and server side
 161
 162 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 163 File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
 164 and the web server is automatically restarted.
 165
 166 ```
 167 $ npm run dev
 168 ```
 169
 170 ### RTL layout
 171
 172 To test RTL layout using `ar` locale:
 173
 174 ```
 175 $ npm run dev -- --ar-locale
 176 ```
 177
 178 ### Testing
 179
 180 #### Unit/integration tests
 181
 182 Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves
 183 as expected and respect the syntax conventions. They will run upon PR submission as part of our CI, but running them beforehand yourself will get you faster feedback and save CI runner time for others.
 184
 185 See the [dedicated documentation](/support/doc/development/tests.md) to run tests locally.
 186
 187 #### Testing the federation of PeerTube servers
 188
 189 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 190 Then, we can create the databases (if they don't already exist):
 191
 192 ```
 193 $ sudo -u postgres createuser you_username --createdb
 194 $ createdb -O peertube peertube_test{1,2,3}
 195 ```
 196
 197 Build the application and flush the old tests data:
 198
 199 ```
 200 $ npm run build
 201 $ npm run clean:server:test
 202 ```
 203
 204 To run 3 nodes:
 205
 206 ```
 207 $ NODE_APP_INSTANCE=1 NODE_ENV=test npm start
 208 $ NODE_APP_INSTANCE=2 NODE_ENV=test npm start
 209 $ NODE_APP_INSTANCE=3 NODE_ENV=test npm start
 210 ```
 211
 212 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
 213 with the `root` as username and `test{1,2,3}` for the password.
 214
 215 Instance configurations are in `config/test-{1,2,3}.yaml`.
 216
 217 ### Emails
 218
 219 To test emails with PeerTube:
 220
 221  * Run [mailslurper](http://mailslurper.com/)
 222  * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=dev node dist/server`
 223
 224 ### Environment variables
 225
 226 PeerTube can be configured using environment variables.
 227 See the list on https://docs.joinpeertube.org/maintain-configuration?id=environment-variables
 228
 229 Additionally to these ones, we provide some environment for dev/test purpose:
 230
 231  * `PRODUCTION_CONSTANTS=true`: in `NODE_ENV=dev` or `NODE_ENV=test` PeerTube customizes some constants. To prevent this behaviour, you can set `PRODUCTION_CONSTANTS` env to
 232  `true`
 233  * `PEERTUBE_LOCAL_CONFIG`: directory to find the local configuration file (used by web admin)
 234  * `NODE_DB_LOG=false`: disable SQL request logging
 235
 236 ## Plugins & Themes
 237
 238 See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins