X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=b12e973617e963cd4e0c0069721e46b25707c974;hb=3e95b6834304ebbff7d796a6a5e096e52813bc77;hp=568b726a5f556baf65e60a7cb2a63736136cb473;hpb=4c1def5fd8e9f483238eb38e221f555e2e6bbf07;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 568b726a5..b12e97361 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -29,13 +29,13 @@ 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. +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. 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 @@ -58,7 +58,7 @@ First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead Make sure that you have followed [the steps](/support/doc/dependencies.md) -to install the dependencies. You'll need to install **NodeJS 10**. +to install the dependencies. Fork the github repository, and then clone the sources and install node modules: