Jirafeau version 2.0.0

[jirafeau_project.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 67bd4b966cc416495284fbb7e977f564de37b538..9876a216996f2b9832e57ab357182f419ca20eb1 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,11 +1,25 @@
+# Contributing
+

 Hi,
 
 Hi,
 

-This document is only made for newcomers in Jirafeau who are digging into
-the code.
+this document is made for newcomers in Jirafeau who are digging into the code.
+
+## General principle
+
+Jirafeau is made in the [KISS](http://en.wikipedia.org/wiki/KISS_principle) way (Keep It Simple, Stupid).
+
+It is meant to be a simple filehosting service, simple to use, simple to install, simple to maintain.
+
+This project won't evolve to a file manager and will focus to keep a very few dependencies.
+
+So things like a markdown parser for the ToS or E-Mail tasks would be usefull for sure, but may be [rejected](https://gitlab.com/mojo42/Jirafeau/issues/37#note_1191566) since they would a lot of dependencies and makes the project more complex.
+
+## Structure

 
 Here is a little explaination of Jirafeau's arboresence in a simplified
 view only to show the most importants files and their role.
 
 
 Here is a little explaination of Jirafeau's arboresence in a simplified
 view only to show the most importants files and their role.
 

+```

 .
 ├── admin.php : adminitration interface, also permits to download files
 ├── f.php : permits to download files or show the download page
 .
 ├── admin.php : adminitration interface, also permits to download files
 ├── f.php : permits to download files or show the download page


@@ -27,13 +41,22 @@ view only to show the most importants files and their role.
     ├── async : chunks of uploaded files
     ├── files : all files that has been successfully uploaded
     └── links : all links pointing to files with meta-informations
     ├── async : chunks of uploaded files
     ├── files : all files that has been successfully uploaded
     └── links : all links pointing to files with meta-informations

+```
+
+## Translations
+
+Translation may be add via [Jirafeau's Weblate](https://hosted.weblate.org/projects/jirafeau/master/).

 
 

-Coding style:
+## Coding style

 
 - PHP function keywords are alone on a line
 
 - PHP function keywords are alone on a line

-- Braces "{" must are put in a new line
-- Files must be in UTF-8 (without BOM)
-- Uses LF (\n) for end of lines
+- Braces "{" must be put in a new line
+- Files must be in UTF-8 without BOM and use Unix Line Endings (LF)
+
+The whole project is not clean about that yet, feel free to fix :)
+
+## Merge Requests

 
 

-The whole project is not clean about that, feel free to fix :)
+Please create one branch for each feature and send one merge request for each branch. 

 
 

+Dont squash several changes or commits into one merge request as this is hard to review.