X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=704b22b8b52b86048253b030bd6c0e4118a48fc3;hb=17aa80ed016bafa3ccb071af3f86054033823284;hp=4b352922eb8572ef1de3aa4a5308c51f6fd8fbdd;hpb=0b4e5fe32708afce54212810738aa4d0c3dc178d;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4b352922e..704b22b8b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,15 +1,30 @@ # 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) - * [Develop](#develop) + + +- [Translate](#translate) +- [Give your feedback](#give-your-feedback) +- [Write documentation](#write-documentation) +- [Improve the website](#improve-the-website) +- [Develop](#develop) + - [Prerequisites](#prerequisites) + - [Online development](#online-development) + - [Server side](#server-side) + - [Client side](#client-side) + - [Client and server side](#client-and-server-side) + - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers) + - [Unit tests](#unit-tests) + - [Emails](#emails) +- [Plugins & Themes](#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. @@ -28,13 +43,22 @@ interested in, user interface, design, decentralized architecture... You can help to write the documentation of the REST API, code, architecture, demonstrations. -For the REST API you can see the documentation in [/support/doc/api](/support/doc/api) directory. -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. +For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory. +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. Some hints: - * Routes are defined in [/server/controllers/](/server/controllers/) directory - * Parameters validators are defined in [/server/middlewares/validators](/server/middlewares/validators) directory - * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory + * Routes are defined in [/server/controllers/](https://github.com/Chocobozzz/PeerTube/tree/develop/server/controllers) directory + * Parameters validators are defined in [/server/middlewares/validators](https://github.com/Chocobozzz/PeerTube/tree/develop/server/middlewares/validators) directory + * Models sent/received by the controllers are defined in [/shared/models](https://github.com/Chocobozzz/PeerTube/tree/develop/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 @@ -46,14 +70,16 @@ before you start working on them :). First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes. -Make sure that you have followed -[the steps](/support/doc/dependencies.md) +Make sure that you have followed +[the steps](/support/doc/dependencies.md) to install the dependencies. -Then clone the sources and install node modules: +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 ``` @@ -62,6 +88,12 @@ 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 +``` + 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` @@ -82,9 +114,15 @@ $ 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: @@ -98,8 +136,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: @@ -122,7 +160,7 @@ and the web server is automatically restarted. $ npm run dev ``` -### Federation +### Testing the federation of PeerTube servers 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): @@ -135,7 +173,7 @@ $ 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 ``` @@ -158,21 +196,32 @@ Then, we can create the databases (if they don't already exist): ``` $ sudo -u postgres createuser you_username --createdb --superuser -$ createdb -O peertube peertube_test{1,2,3,4,5,6} +$ 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 --require ts-node/register/type-check --bail server/tests/api/index.ts +$ 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. + +### Emails + +To test emails with PeerTube: + + * Run [mailslurper](http://mailslurper.com/) + * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=test npm start` + +## Plugins & Themes + +See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins