Begin a CONTRIBUTING guide
authorChocobozzz <florian.bigard@gmail.com>
Fri, 22 Jul 2016 09:45:29 +0000 (11:45 +0200)
committerChocobozzz <florian.bigard@gmail.com>
Fri, 22 Jul 2016 09:45:29 +0000 (11:45 +0200)
.github/CONTRIBUTING.md [new file with mode: 0644]

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..c777900
--- /dev/null
@@ -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...