Vous avez trouvé un bug ou vous avez une idée pour une nouvelle fonctionnalité intéressante ? Contribuer au code est un excellent moyen de redonner quelque chose à la communauté open source. Avant de plonger directement dans le code, il y a quelques directives que nous devons suivre pour que nous puissions avoir une chance de rester au courant des choses.
Assurez-vous d'avoir un compte JIRA.
Assurez-vous d'avoir un compte GitHub.
Si vous envisagez d'implémenter une nouvelle fonctionnalité, il est logique de discuter d'abord de vos modifications sur la liste des développeurs. De cette façon, vous pouvez vous assurer que vous ne perdez pas votre temps sur quelque chose qui n'est pas considéré comme faisant partie du champ d'application d'Apache Maven.
Soumettez un ticket pour votre problème, en supposant qu’il n’en existe pas déjà un.
Décrivez clairement le problème, y compris les étapes à suivre pour le reproduire lorsqu'il s'agit d'un bug.
Assurez-vous de remplir la première version dont vous savez qu'elle pose problème.
Forkez le référentiel sur GitHub.
Nous acceptons les Pull Requests via GitHub. La liste de diffusion des développeurs est le principal canal de communication pour les contributeurs.
Il existe quelques lignes directrices qui nous faciliteront l’application des PR :
Créez une branche thématique à partir de laquelle vous souhaitez baser votre travail (il s'agit généralement de la branche principale). Envoyez vos modifications vers une branche de sujet dans votre fork du référentiel.
Effectuez des validations d’unités logiques.
Respectez le style de code d'origine : en utilisant le même style de code, les correctifs ne doivent que mettre en évidence la différence réelle, sans être perturbés par des problèmes de formatage :
Utilisez uniquement des espaces pour l'indentation.
Créez des différences minimales : désactivez les actions de sauvegarde telles que le reformatage du code source ou l'organisation des importations. Si vous pensez que le code source doit être reformaté, créez un PR distinct pour cette modification.
Vérifiez les espaces inutiles avec git diff --check
avant de vous engager.
Assurez-vous que vos messages de validation sont au format approprié. Votre message de validation doit contenir la clé du problème JIRA.
[MSHARED-XXX] - Subject of the JIRA Ticket Optional supplemental description.
Assurez-vous d'avoir ajouté les tests nécessaires (JUnit/IT) pour vos modifications.
Exécutez tous les tests avec mvn -Prun-its verify
pour vous assurer que rien d'autre n'a été accidentellement cassé.
Soumettez une demande d'extraction au référentiel de l'organisation Apache.
Mettez à jour votre ticket JIRA et incluez un lien vers la pull request dans le ticket.
Si vous envisagez de contribuer régulièrement, veuillez envisager de déposer un contrat de licence de contributeur.
Pour des modifications de nature triviale dans les commentaires et la documentation, il n'est pas toujours nécessaire de créer un nouveau ticket dans JIRA. Dans ce cas, il convient de commencer la première ligne d'un commit par '(doc)' au lieu d'un numéro de ticket.
Correctifs contributeurs
Page du projet de composants partagés Apache Maven
Contrat de licence de contributeur
Documentation générale sur GitHub
Documentation sur les demandes d'extraction GitHub
Compte Twitter Apache Maven
Canal IRC #Maven sur freenode.org