X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=7c480c52f049f1ec51d63d3c4a2f28e191ec275c;hb=1bcb03a100d172903b877d6a0e4ed11d63b14f3d;hp=2af5c236ae753e60827937d5eb3ac918d67e5802;hpb=a3e6d181996075752b77e0d5a367b62cc45c731b;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2af5c236a..7c480c52f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -74,17 +74,16 @@ link your PR to the issues it solves by using the GitHub syntax: "fixes #issue_n 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 +1) Make sure that you have followed [the steps](/support/doc/dependencies.md) to install the dependencies. - -Fork the github repository, -and then clone the sources and install node modules: - +1) Install [parallel](https://www.gnu.org/software/parallel/) to be able to run tests. +1) Fork the Github repository. +1) Run the following commands. ``` $ git clone https://github.com/Chocobozzz/PeerTube -$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git $ cd PeerTube +$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git $ yarn install --pure-lockfile ``` @@ -192,7 +191,13 @@ $ npm test If you just want to run 1 test (which is what you want to debug a specific test rapidly): ``` -$ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/index.ts +$ TS_NODE_FILES=true npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/videos/single-server.ts +``` + +While testing, you might want to display a server's logs: + +``` +NODE_APP_INSTANCE=1 NODE_ENV=test npm run parse-log -- --level debug | less +GF ``` Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.