X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=1672ebfa9b7523eee8982f9f6cb9b32f6b6650c0;hb=d89954ff0ba4bd51ee88a4691c7b377a1252f889;hp=b880270421842bbd368458f4518bfbd99866c09b;hpb=53da06304957c7980c759c0db3e93010f4de7db3;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b88027042..1672ebfa9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -59,10 +59,12 @@ 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 ``` @@ -71,6 +73,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` @@ -113,7 +121,7 @@ restart. ### Client side -You can find a documentation of the server code/architecture +You can find a documentation of the client code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code). @@ -173,13 +181,13 @@ 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 ```