Enquanto eu scrollava o LinkedIn, vi uma publicação da Pachi Parra que me fez parar pra pensar:
Isso me lembrou o quanto ainda subestimamos a importância de um guia de contribuição em projetos open source e o quanto isso pode afastar novas pessoas colaboradoras antes mesmo do primeiro PR.
O que é um Guia de Contribuição?
O Guia de Contribuição (geralmente chamado de CONTRIBUTING.md) é um arquivo que explica como alguém pode contribuir com o seu projeto.
Ele é o mapa que orienta novas pessoas colaboradoras e sem ele, mesmo o projeto mais promissor pode parecer confuso ou inacessível.
Ele costuma incluir:
- Como configurar o ambiente local;
- Padrões de código e estilo;
- Como abrir issues e pull requests;
- Regras de comunicação e revisão;
- Links para o Código de Conduta e documentação.
Por que ele é essencial para o seu projeto?
Ter um guia de contribuição não é burocracia, é acessibilidade. É a forma mais simples de dizer “você é bem-vindo aqui" especialmente para quem está começando a contribuir em projetos open source.
Além disso, ele:
- Reduz retrabalho e dúvidas repetidas;
- Melhora a qualidade das contribuições;
- Cria uma base de confiança e pertencimento;
Como criar o seu (sem complicação)
Você pode começar com algo simples, como este modelo:
# Contribuindo com o Projeto
Obrigado por querer contribuir! ❤️
## Passo a passo
1. Faça um fork do repositório;
2. Crie uma branch para sua feature ou correção (`git checkout -b minha-feature`);
3. Faça o commit das suas mudanças (`git commit -m 'Adiciona nova feature'`);
4. Envie sua branch (`git push origin minha-feature`);
5. Abra um Pull Request e descreva o que foi alterado.
Antes de começar, leia o nosso [Código de Conduta](./CODE_OF_CONDUCT.md).
Pronto. Mesmo algo curto como isso já melhora a experiência de quem chega ao projeto.
Conclusão
Se você mantém um projeto open source, crie seu guia de contribuição hoje mesmo.
Não precisa ser perfeito, ele vai evoluir com o tempo, assim como o projeto.
Mas começar é o passo mais importante para transformar seu repositório em um projeto que as pessoas realmente vão se sentir confortáveis em contribuir.
Vou deixar aqui como exemplo o guia de contribuição do Diciotech - um projeto open source que sou mantenedora: https://github.com/levxyca/diciotech/blob/main/CONTRIBUTING.md
Ele é um ótimo exemplo de como um guia de contribuição pode sair do básico que vimos hoje para algo robusto para quem for contribuir!