+# Contributing
+
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.
+```
.
-├── admin.php : adminitration interface, also permits to download files
+├── admin.php : administration interface to manage links and files
├── f.php : permits to download files or show the download page
-├── index.php : only provide a html/javascript client to interact with API
-├── script.php : API interface and it's html documentation
+├── index.php : provides a web interface to interact with API
+├── script.php : API interface (all file actions happen here - upload, deletion, etc)
├── install.php : installation script
-├── tos.php : terms of use the user may edit
+├── tos.php : "Terms of Service" page
├── lib
-│ ├── config.local.php : user's parameters
-│ ├── config.original.php : default parameters with their documentation
-│ ├── functions_*.js : javascript functions for html/javascript client
-│ ├── functions.php : core functions and tools of jirafeau
-│ ├── locales : langage folder, contain all langage files
+│ ├── config.original.php : default parameters
+│ ├── config.local.php : the users parameters (auto generated, not versionized)
+│ ├── functions_*.js : JavaScript functions for index.php (AJAX etc)
+│ ├── functions.php : core functions and tools of Jirafeau
+│ ├── tos.original.txt : default text show on the ToS page
+│ ├── tos.local.txt : a users alternative text show on the ToS page (not versionized)
+│ ├── settings.php : core settings of Jirafeau, includes the configuration params automatically
+│ ├── locales : language folder, contains all language files
│ └── template
-│ ├── footer.php
-│ └── header.php
+│ ├── footer.php : footer with links to source and ToS for all HTML views
+│ └── header.php : header with logo and title for all HTML views
├── media : folder containing all skins
-└── var-xxxxxxx : folder containing all data
- ├── async : chunks of uploaded files
- ├── files : all files that has been successfully uploaded
- └── links : all links pointing to files with meta-informations
+└── var-xxxxxxx : the users folder containing all data (auto generated, not versionized)
+ ├── async : chunks of uploaded files (not succressfull yet)
+ ├── files : all files that have been uploaded successfully
+ ├── [hashed file name] : the original file
+ ├── [hashed file name]_count : count many links to this file exist
+ └── links : all links, including meta-informations, pointing to files
+ ├── [link] : the link file, includes which original file should be used and some meta data like creation date, expiration time
+```
+
+## 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
-- 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.
git.p6c8.net / jirafeau.git / blobdiff