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