Chez Adoptium, nous voulons aider les gens à se lancer dans l’Open Source, Java et la communauté Java. Il est donc très important pour nous de fournir de l’aide aux personnes qui souhaitent commencer à travailler sur des projets open source.
Note
Cette documentation est encore en cours d’élaboration et certains points mentionnés sont des idées pour l’avenir qui n’ont pas encore été mises en place.
Adoptium propose plusieurs issues étiquetées comme good first issue. Toutes ces issues sont parfaites pour commencer à travailler sur un projet open source. Les issues fournissent des descriptions conviviales et de nombreux liens utiles vers des documentations et tutoriels pour commencer directement à travailler sur une issue. Même si vous n’êtes pas vraiment familier avec GitHub en général, les issues renvoient vers des tutoriels conviviaux qui vous aideront à comprendre les workflows des forks et des pull requests.
Vous pouvez trouver un exemple de good first issue dans le dépôt IcedTea-Web.
Sur GitHub, vous pouvez trouver une liste de toutes les issues étiquetées good first issue.
Modèles
Nous travaillons actuellement sur un modèle d’issue pour les issues étiquetées comme good first issue. La version actuelle du modèle d’issue et une section sur le « Support pour les premiers contributeurs » pour les fichiers contributing.md sont actuellement en développement.
Workflow pour créer des good first issues
Chaque fois que vous estimez qu’une issue pourrait être une good first issue, vous devriez l’étiqueter avec le label good first issue - candidate.
Ce faisant, elle pourra être examinée et modifiée pour devenir une good first issue.
Sur GitHub, vous pouvez trouver une liste de toutes les issues étiquetées good first issue - candidate.
Toutes les issues étiquetées good first issue - candidate doivent être examinées et éventuellement remaniées pour devenir des issues étiquetées good first issue.
Les règles suivantes doivent être appliquées :
-
Le titre de l’issue doit spécifier le problème
-
La description de l’issue doit être basée sur notre modèle
good first issue -
L’issue ne devrait pas contenir de commentaires. Les commentaires rendent déjà la compréhension plus difficile pour un débutant. Toutes les informations pertinentes dans les commentaires doivent être ajoutées à la description de l’issue. Les commentaires doivent être supprimés par la suite. Si cela n’est pas possible, la meilleure solution est de créer une nouvelle issue pour la good first issue, de la lier à l’originale, et de fermer l’originale.
-
Lors de la définition de la description de l’issue, il est toujours judicieux de renvoyer vers des documentations ou des fichiers utiles (peut-être même directement vers le code) pour aider un nouveau contributeur à trouver le bon point de départ pour travailler sur l’issue.
Une fois l’issue remaniée et examinée, elle doit être étiquetée comme good first issue et le label good first issue - candidate doit être retiré.
De plus, nous devons étiqueter toutes ces issues avec help wanted et Hacktoberfest.
