add contributing guide

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+Guide du contributeur
+=====================
+
+Il y a plusieurs moyens de contribuer :
+
+- Si vous trouvez un problème dans le jeu, vous pouvez ouvrir une [*issue*](https://github.com/rtfmcorp/asylamba-game/issues) en décrivant le problème, directement dans l'interface de Github.
+- Si vous voulez directement corriger un problème, vous pouvez le faire, pour cela merci de suivre la procédure ci-dessous.
+
+Quel type de problème régler ?
+------------------------------
+
+Il est possible de trouver une *issue* que vous souhaitez régler. Dans ce cas, mettez un commentaire dans l'issue, ainsi on saura que vous bossez dessus. S'il n'y a pas d'issues, vous pouvez soit la créer, soit directement faire le correctif.
+
+Voici les différentes choses que vous pouvez faire :
+
+- corriger des fautes d'orthographe ou fautes de frappe
+- faire du refactoring, optimisation
+- optimiser l'interface (reponse design par exemple)
+- créer de la documentation (dans ce cas, il serait mieux de discuter en premier lieu de la technique utilisée, ainsi d'autres personnes pourront vous aider, et vous aurez plus de chance que ça soit accepté)
+
+En ce qui concerne l'ajout ou la modification de fonctionnalités, il est fort probable que ça soit refusé. Si vous souhaitez vous lancer là-dedans, il faut en discuter au préalable avec l'équipe de développement, directement sur le forum du jeu ou sur le serveur Discord d'Asylamba. Cela permettra de ne pas sortir de la ligne directrice.
+
+Comment contribuer ?
+--------------------
+
+En premier lieu, vous devez *forker* le dépôt sur votre compte. A partir de là, vous pouvez faire divers *commit* pour arriver à votre but. Quand tout fonctionne vous pouvez soumettre une *pull request* sur la branche *dev* du dépôt principal.
+
+La branche principale est *master*, la branche *dev* sert au développement. Nous n'accepterons donc des PR que sur cette dernière.
+
+*Conseil : Nous vous conseillons de faire une branche sur votre fork pour faire vos modifications. Ainsi le temps que votre PR soit acceptée ou refusée, vous pouvez faire d'autres branches pour bosser sur d'autres issues. Pensez que tous les commits faits après une PR sur la même branche sont ajouté à la PR.* 
+
+Un guide de contribution officiel est disponible [ici](https://guides.github.com/activities/contributing-to-open-source/#contributing). Nous sommes également disponible si vous avez des questions sur la façon de faire. Vous pouvez nous contacter sur Asylamba, par mail ou sur Discord.
+
+Les bonnes pratiques
+--------------------
+
+- respecter les conventions au niveau du code (espacement, retour à la ligne, tabulations, nommage)
+- le code (nom de variables, etc.) doit être en anglais
+- les commentaires sont en anglais ou en français
+- les commits doivent avoir un nom clair (soit en français soit en anglais)
+- un commit modifie/améliore une chose, ça doit être clair et concis

README.md

@@ -1,35 +1,49 @@
-# ASYLAMBA : Expansion Stellaire
+ASYLAMBA : Expansion Stellaire
+==============================
 
 Jeu de stragégie en ligne multi-joueur. [http://asylamba.com](http://asylamba.com)
 
+![](http://asylamba.com/public/media/files/sources/asylambacom.png)
 
-## Dépendances
+Dépendances
+-----------
 
 - Apache 2.4.7
 - PHP 5.5.9
 - MySQL 5.5.49
 
-## Installation
+
+Installation
+------------
 
 Procédure pour une installation locale :
 
 - copier `index.default.php` et le renommer en `index.php`, y modifier la constante PUBLICR avec votre chemin
-- copier `system/config/app.config.local.default.php` et le renommer `app.config.local.php`, y modifier la constante APP_ROOT et d'autres infos (connexion à la base de données, etc.)
-- créer une base de données (nom correspondant à la constante DEFAULT_SQL_DTB du fichier du point précédent)
+- copier `system/config/app.config.local.default.php` et le renommer `app.config.local.php`, y modifier la constante `APP_ROOT` et d'autres infos (connexion à la base de données, etc.)
+- créer une base de données (nom correspondant à la constante `DEFAULT_SQL_DTB` du fichier du point précédent)
 
-A partir de là, vous pouvez accéder à une interface qui permet de créer toutes les tables de la base de données : http://localhost/[ votre chemin ]/script. Pour faire l'installation, cliquez sur le premier bouton "deploy.dbinstall". 
+A partir de là, vous pouvez accéder à une interface qui permet de créer toutes les tables de la base de données : `http://localhost/[votre chemin]/script`. Pour faire l'installation, cliquez sur le premier bouton "deploy.dbinstall". 
 
-Si aucune erreur s'affiche, vous pouvez ensuite créer des personnages en allant sur http://localhost/[ votre chemin ]/buffer. Cette interface permet de se connecter à tous les personnages créés.
+Si aucune erreur s'affiche, vous pouvez ensuite créer des personnages en allant sur `http://localhost/[votre chemin]/buffer`. Cette interface permet de se connecter à tous les personnages créés.
 
 Trois scripts permettent de mettre à jour le jeu quotidiennement, il s'agit des trois boutons sous le titre "Tâches Cron". Vous pouvez soit les lancer à la main, soit appeler leurs URLs avec des crons.
 
 
-## Contributeurs
+Contribuer
+----------
+
+Si vous souhaitez contribuer au projet, c'est possible ! Merci de prendre connaissance des [instructions](CONTRIBUTING.md) avant de commencer.
+
+
+Contributeurs
+-------------
 
 * [abdelaz3r](https://github.com/abdelaz3r)
 * [acknowledge](https://github.com/acknowledge)
 * [N03](https://github.com/N03)
 
-## Licence
+
+Licence
+-------
 
 [WIP]