No Adoptium, queremos ajudar as pessoas a ingressar no Open Source, Java e na Comunidade Java. Por isso, é muito importante para nós fornecer ajuda às pessoas que desejam começar a trabalhar em projetos de código aberto.
Note
Esta documentação ainda está em desenvolvimento e alguns pontos mencionados são ideias para o futuro que ainda não foram implementadas.
O Adoptium fornece várias issues rotuladas como good first issue. Todas essas issues são perfeitas para começar a trabalhar em um projeto de código aberto. As issues fornecem descrições amigáveis e muitos links úteis para documentações e tutoriais para começar a trabalhar imediatamente nelas. Mesmo que você não esteja muito familiarizado com o GitHub em geral, as issues apontam para tutoriais amigáveis que ajudarão os usuários a entender os fluxos de trabalho de forks e pull requests.
Você pode encontrar um exemplo de good first issue no repositório IcedTea-Web.
No GitHub, você pode encontrar uma lista de todas as issues rotuladas como good first issue.
Templates
Estamos atualmente trabalhando em um template de issue para issues rotuladas como good first issue. A versão atual do template de issue e uma seção sobre "Suporte para iniciantes" em arquivos contributing.md estão atualmente em desenvolvimento.
Fluxo de trabalho para criar good first issues
Sempre que você achar que uma issue pode ser uma good first issue, você deve rotulá-la com o rótulo good first issue - candidate.
Ao fazer isso, ela pode ser revisada e modificada para se tornar uma good first issue
No GitHub, você pode encontrar uma lista de todas as issues rotuladas como good first issue - candidate.
Todas as issues rotuladas como good first issue - candidate devem ser revisadas e talvez reformuladas para se tornarem issues rotuladas como good first issue.
As seguintes regras devem ser aplicadas:
-
O título da issue deve especificar o problema
-
A descrição da issue deve ser baseada em nosso template
good first issue -
A issue não deve conter comentários. Comentários tornam mais difícil a compreensão para um iniciante. Todas as informações relevantes nos comentários devem ser adicionadas à descrição da issue. Os comentários devem ser removidos depois. Se isso não for possível, a melhor solução é criar uma nova issue para a good first issue, vinculá-la à original e fechar a original.
-
Ao definir a descrição da issue, sempre faz sentido incluir links para documentações ou arquivos úteis (talvez diretamente para o código) para ajudar um iniciante a encontrar o ponto de partida correto para trabalhar na issue.
Após a issue ser reformulada e revisada, ela deve ser rotulada como good first issue e o rótulo good first issue - candidate deve ser removido.
Além disso, devemos rotular todas essas issues com help wanted e Hacktoberfest.
