Il y a plusieurs moyens de contribuer :
- Si vous trouvez un problème dans le jeu, vous pouvez ouvrir une issue 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.
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 (reponsive 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.
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. 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.
- 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
- chaque modification/ajout doit être accompagné de tests unitaires pertinents assurant le bon fonctionnement du code
Si vous souhaitez modifier le CSS, il faudra éditer les fichiers au format LESS se trouvant dans public/css/less/. Afin de compiler ces fichiers en CSS, il faut utiliser Gulp. Vous devez d'abord installer NPM puis GULP sur votre système, ensuite il faut installer les dépendances du projet en tapant :
npm install
Les dépendances s'installeront dans le dossier node_modules/. Pour compiler le CSS, il suffit de taper :
gulp less
Pour lancer les tests automatisés de l'application, vous pouvez lancer la commande suivante :
make test