IntenseWebs/PeerTube
3
0
Fork 0
mirror of https://github.com/Chocobozzz/PeerTube.git synced 2024-11-22 08:46:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

Begin a CONTRIBUTING guide

Browse Source
This commit is contained in:
Chocobozzz 2016-07-22 11:45:29 +02:00
parent 00ffc03ece
commit 7a7edb7241
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
.github/CONTRIBUTING.md vendored Normal file
View File

@ -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...