Nous vous remercions de l'intérêt que vous portez à Mercator et de votre volonté d'y contribuer ! Ce document décrit notre politique de contribution afin d'assurer que notre projet reste convivial, productif et agréable pour tous les participants.
Notre projet adhère à un Code de Conduite qui définit les comportements attendus et les comportements inacceptables. Nous attendons de tous les contributeurs qu'ils lisent et respectent ce code.
Avant de commencer à travailler sur une contribution, veuillez consulter les issues existantes et les discussions pour voir si votre sujet a déjà été abordé. Si vous avez des questions ou souhaitez discuter d'une idée, utilisez les discussions ou ouvrez une nouvelle issue.
Nous vous conseillons de commencer par présenter une description détaillée de votre contribution avant de la développer, afin de recueillir des avis et des retours des mainteneurs et des autres contributeurs.
Cette approche permet de s'assurer que la contribution est alignée avec les objectifs du projet et peut éviter des efforts inutiles si la contribution proposée ne correspond pas aux besoins actuels du projet.
-
Fork le répertoire principal depuis GitHub.
-
Clone votre fork localement :
git clone -b dev https://github.com/dbarzin/mercator.git
-
Configurez le dépôt principal comme
remote upstream:git remote add upstream https://github.com/dbarzin/mercator.git
Créez une nouvelle branche pour votre travail. Utilisez un nom de branche descriptif :
git checkout -b nom-de-la-brancheEffectuez vos modifications dans la nouvelle branche. Assurez-vous de :
- Suivre les conventions de codage du projet.
- Ajouter ou mettre à jour les tests si nécessaire.
- Vérifier que tous les tests passent avant de soumettre votre contribution.
Avant de soumettre une pull request, assurez-vous que votre fork est à jour avec le dépôt principal :
git fetch upstream
git checkout dev
git merge upstream/nom-de-la-branche-
Poussez votre branche vers votre fork :
git push origin nom-de-la-branche
-
Ouvrez une pull request sur GitHub depuis votre branche vers la branche dev du projet.
Dans la description de la pull request, veuillez inclure les informations suivantes :
- Une description claire de ce que fait votre contribution.
- Toute information contextuelle nécessaire (liens vers des issues, etc.).
- Une note sur les tests ajoutés ou modifiés.
Votre pull request sera examinée par les mainteneurs du projet. Nous vous demandons d'être réceptif aux commentaires et de faire les modifications nécessaires. Une fois approuvée, votre contribution sera fusionnée dans la branche principale.
Notre philosophie générale en matière d'octroi de crédits est la suivante :
-
Nous citons le nom de tous les contributeurs. Lors de la soumission d'une contribution, nous attendons des contributeurs qu'ils fournissent des informations précises sur les personnes qui ont contribué au travail.
-
Les responsables du projet sont les seuls à pouvoir déterminer qui est crédité.
-
Si une contribution comprend un travail substantiel de plusieurs auteurs, nous attribuerons le crédit principal au contributeur le moins expérimenté.
-
Si nous devons réécrire une contribution, nous collaborerons avec l'auteur original pour apporter les modifications nécessaires, pour autant qu'il réponde de bonne foi et dans les délais impartis. Dans tous les cas, c'est l'auteur original qui sera crédité en premier lieu.
-
Toutes les personnes et organisations impliquées dans la contribution sont créditées de la même manière.
-
Si plusieurs contributeurs soumettent des travaux similaires, l'auteur accepté reçoit le crédit principal et tous les autres contributeurs dont les travaux ont été rejetés reçoivent un crédit secondaire.
En contribuant à Mercator, vous acceptez que votre contribution soit sous la même licence que le projet principal. Mercator est sous licence GPLv3.
Nous apprécions grandement toutes les contributions et remercions chaque contributeur pour leur temps et leurs efforts. Ensemble, nous pouvons rendre Mercator meilleur pour tout le monde !