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