diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..c7779000d --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# Welcome to the contributing guide for PeerTube + +Interesting in contributing? Awesome :) + +**Quick Links:** + + * [Give your feedback](#give-your-feedback) + * [Develop on the Server side}(#develop-on-the-server-side) + * [Develop on the Client side](#develop-on-the-client-side) + * [Write documentation](#write-documentation) + + +## Give your feedback + +Even if you are not a developer, or you do not want to develop on PeerTube you can give a feedback on potential bugs, features that you are interested in, user interace, design, decentralized architecture... + + +## Develop on the Server side + +The server is a web server developed with [NodeJS](https://nodejs.org)/[Express](http://expressjs.com). + +Newcommer? You can find a documentation of the server code/architecture [here](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md). + +Do not hesitate to talk about the functionnality you want to develop by creating an issue :) + + +## Develop on the Client side + +The client is a web application developed with [TypeScript](https://www.typescriptlang.org/)/[Angular2](https://angular.io/) + + +## Write documentation + +You can help to write the documentation of the REST API, code, architecture, demonstrations...