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