Tornar o repositório visível
Mantenha o repositório público, ativo e fácil de avaliar em GitHub sem contexto privado.
Para mantenedores
Para mantenedores
Ajude Good First Issue a descobrir, avaliar e manter o trabalho amigável para iniciantes em seu repositório, útil para novos contribuidores.
Discovery
Indexe seu repositório
Good First Issue atualmente indexa repositórios públicos GitHub e GitHub aberto issues. Os mantenedores podem enviar um repositório GitHub público diretamente após o login, e o rastreador issue irá buscá-lo após a criação do registro do repositório.
Documente os fundamentos do projeto
Mantenha o guia README, CONTRIBUTING, a licença, a configuração local e as instruções de teste claras o suficiente para serem seguidas por um novo colaborador.
Envie o repositório
Envie o repositório público após fazer login. Depois que o registro do repositório for criado, o rastreador issue continuará processando issues aberto.
Issue labels
Etiqueta issues para iniciantes
A tarefa de busca atual procura GitHub por issues aberto com good first issue e help wanted labels. Esses labels tornam seu trabalho mais fácil de descobrir, mas o issue ainda precisa de contexto suficiente para que um colaborador iniciante aja com segurança.
Inclua contexto suficiente para tornar o primeiro pull request revisável
- Antecedentes que explicam por que o issue é importante.
- Resultado esperado em termos concretos.
- Arquivos, pacotes ou áreas de produtos a serem inspecionados primeiro.
- Comandos de teste ou etapas de verificação manual.
- Se os contribuidores devem confirmar o escopo antes da codificação.
Recommendations
Melhore a qualidade das recomendações
As recomendações funcionam melhor quando o repositório mostra manutenção ativa e o issue é pequeno o suficiente para que um novo contribuidor termine sem adivinhar a direção do projeto.
Manutenção recente
Commits, respostas e atividades de triagem recentes ajudam os contribuidores a confiar que review ainda é possível.
Limpar escrita issue
Issues com contexto, critérios de aceitação e notas de configuração são mais fáceis de combinar com novos contribuidores.
Escopo revisável pequeno
Documentação de baixo risco, testes, aprimoramento da interface do usuário e pequenas correções de bugs são mais fáceis de recomendar do que um amplo trabalho de design.
Ciclo de contribuidor saudável
Testes executáveis e feedback responsivo reduzem pull requests abandonados e mantêm as recomendações úteis.
Evite issues que parecem adequados para iniciantes, mas são difíceis de terminar
- issues obsoleto que nenhum mantenedor confirmou recentemente.
- Recursos grandes com propriedade ou direção do produto pouco clara.
- Tarefas que requerem contexto privado, credenciais ou acesso de liberação.
- Issues sem notas de reprodução, orientação de configuração ou comportamento esperado.
Pronto para adicionar um repositório?
Envie um repositório GitHub público desta página e, em seguida, use issues indexado e canais de feedback para verificar como seu trabalho para iniciantes aparece.