Guias de projetos

Modelo de CONTRIBUTING.md para um repositório de código aberto

Um arquivo CONTRIBUTING.md ajuda alguém a passar de “quero ajudar” a uma issue ou pull request útil. Explique a menor contribuição aceita e como verificá-la. Os requisitos devem refletir como o projeto realmente funciona, não um processo ambicioso que ninguém segue.

Equipe editorial do GitHubStart · Atualizado

Copie e adapte o modelo de contribuição

Substitua os campos e verifique cada comando e link. Continue acolhendo correções de documentação e relatos de bugs mesmo quando o colaborador ainda não estiver pronto para alterar o código da aplicação.

# Contribuindo

## Antes de começar
Leia o README e confira as issues existentes.
Para mudanças grandes, discuta a abordagem antes de implementá-la.

## Configuração local
[Ambiente de execução necessário e comandos de configuração verificados]

## Relatar um bug
Inclua versão, ambiente, etapas, resultado esperado e resultado real.
Remova segredos e dados pessoais dos logs.

## Enviar um pull request
- Explique o problema e a mudança proposta.
- Mantenha a mudança focada.
- Execute [as verificações específicas do projeto].
- Atualize a documentação afetada.

## Revisão
[Quem revisa, como responder e disponibilidade realista]

## Outras formas de ajudar
[Documentação, exemplos, traduções ou relatos reproduzíveis]

Facilite encontrar as orientações

O GitHub reconhece orientações de contribuição na raiz do repositório e nos diretórios docs ou .github. Inclua também um link no README, para que quem leia a introdução do projeto encontre o processo imediatamente.

Revise o percurso a partir dos pontos reais de entrada para contribuições no repositório. Se houver vários arquivos de orientações, harmonize instruções conflitantes. Um colaborador não deve receber um comando de configuração no README e outro diferente e incompatível no guia de contribuição.

Planeje uma primeira contribuição acessível

Escolha uma tarefa pequena com resultado claro, como corrigir um exemplo para um ambiente de execução compatível. Explique como reproduzir o problema, qual comportamento deve mudar e como conferir a conclusão. Evite classificar uma tarefa como adequada a iniciantes se ela depender de conhecimento interno não documentado.

Informe honestamente sua disponibilidade para revisão. Se não puder prometer um prazo de resposta, explique como os colaboradores podem consultar o status. Limites claros reduzem o trabalho abandonado e são mais úteis do que prometer integrar todas as contribuições.

Perguntas frequentes

CONTRIBUTING.md substitui README.md?

Não. O README explica o projeto e como usá-lo. As orientações de contribuição explicam como propor e verificar mudanças.

Devo copiar os comandos de teste de outro projeto?

Somente se também forem os comandos corretos para o seu projeto. Substitua os campos por comandos que você realmente verificou.

Orientações de contribuição garantem mais colaboradores?

Não. Elas reduzem a incerteza das pessoas interessadas, mas a utilidade do projeto, a qualidade das tarefas e o acompanhamento dos mantenedores continuam importantes.

Referências