aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github
diff options
context:
space:
mode:
authorChocobozzz <florian.bigard@gmail.com>2016-07-22 11:45:29 +0200
committerChocobozzz <florian.bigard@gmail.com>2016-07-22 11:45:29 +0200
commit7a7edb72413077da772414507fbf1097fb8f3677 (patch)
treeb07a8d1c8158723cbb7879284f577ed6a1a48e41 /.github
parent00ffc03ece038ca42970624bc6efba5ddccb708b (diff)
downloadPeerTube-7a7edb72413077da772414507fbf1097fb8f3677.tar.gz
PeerTube-7a7edb72413077da772414507fbf1097fb8f3677.tar.zst
PeerTube-7a7edb72413077da772414507fbf1097fb8f3677.zip
Begin a CONTRIBUTING guide
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md34
1 files changed, 34 insertions, 0 deletions
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 @@
1# Welcome to the contributing guide for PeerTube
2
3Interesting in contributing? Awesome :)
4
5**Quick Links:**
6
7 * [Give your feedback](#give-your-feedback)
8 * [Develop on the Server side}(#develop-on-the-server-side)
9 * [Develop on the Client side](#develop-on-the-client-side)
10 * [Write documentation](#write-documentation)
11
12
13## Give your feedback
14
15Even 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...
16
17
18## Develop on the Server side
19
20The server is a web server developed with [NodeJS](https://nodejs.org)/[Express](http://expressjs.com).
21
22Newcommer? You can find a documentation of the server code/architecture [here](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
23
24Do not hesitate to talk about the functionnality you want to develop by creating an issue :)
25
26
27## Develop on the Client side
28
29The client is a web application developed with [TypeScript](https://www.typescriptlang.org/)/[Angular2](https://angular.io/)
30
31
32## Write documentation
33
34You can help to write the documentation of the REST API, code, architecture, demonstrations...