Skip to content

Contributions

McMuzzle edited this page Mar 28, 2017 · 4 revisions

Contributions au projet

Si vous êtes sur cette page, c'est probablement que vous envisagez participer au projet. Voici donc la marche à suivre.

Avant de commencer

Comme le projet est sur github, il est nécessaire d'installer git sur le pc que vous utiliserez pour travailler. https://git-scm.com/downloads

Un outil visuel pour faire du GIT : https://tortoisegit.org/download/

Le protocole général

Pour pouvoir travailler sur une copie du projet sans perturber le reste des travaux des autres, il faut créer un fork du projet. Donc une fois logué dans github, il faut aller sur la page du projet et utilisez le petit bouton en forme de Y en haut à droite pour faire un fork du projet sur votre compte github. Ceci vous permettra d'avoir une copie du repository(le repo) sur votre compte et pouvoir faire ce que vous voulez sur ce repo. Toutes modifications sur le repo principale étant réservées aux administrateurs.

Une fois que vous avez votre repo, le clone permet de le descendre en local. C'est d'ici que vous pouvez faires des branches qui permettrons d'effectuer vos modifications et garder un suivi.

Et la Commit commit commit ...

Quand vous avez fini une correction sur une vos branches vous faites un push. Github le détecte et vous propose normalement d'effectuer un PullRequest. Le pullRequest est un outil qui permet d'indiquer aux administrateurs que vous avez des modifications à proposer.

Ensuite, le pullrequest sera étudié par la communauté, possiblement commenté. Si vous devez le modifier, il suffit de faire les modifications sur votre branche et faire un nouveau push de cette branche, normalement le pullRequest est mis à jours automatiquement.

Quand tout sera validé, vos modifications seront intégrées dans le projet, vous serez officiellement un contributeur!!!

Choisir quoi faire

Pour tout ce qui est documentation, c'est simple il faut parcourir les documents, et quand on trouver des incohérences, des erreurs, on peut proposer des corrections. Si un sujet n'est pas clair, un petit passage sur le chat ou un message aux admin permettra de clarifier. Les contributions sur le wiki sont aussi possible pour les personnes ayant déjà contribué au projet.

Pour les contributions de code, Il faut regarder dans l'onglet Issue et chercher un bug ou fonctionnalité avec un tag "ready" et simplement le mettre en place. Normalement quand un Issue est ready, les tests sont prêts et il existe une documentation de conception si c'est une fonctionnalité.

Pour les contributions au niveau graphisme, tout est à faire. Aucune décision n’a été prise sur l'allure du jeu. Donc des proposition dans un design document peuvent être intéressantes.