Essa é uma submissão para o Desafio de escrita do Hacktoberfest 2025: Reflexões sobre Open Source.
Tenha um README.md legal
Esse arquivo é basicamente a vitrine do seu projeto. Então faz sentido que você dedique um tempo nele, deixando-o completo, contando com descrição do projeto, como executá-lo (caso seja código), versionamento, como usá-lo etc.
Crie o CONTRIBUTING.md
Esse será um dos arquivos principais. É nele que você vai adicionar as orientações de como as pessoas podem contribuir com o seu projeto. E quanto mais completo, melhor será. Você pode incluir que a pessoa precisa, por exemplo, fazer um fork do projeto, criar uma branch para contribuição, colocar as regras de como nomear a branch, os commits, as pull requests, adicionar exemplos de contribuição, entre outras coisas que ajudam a padronizar e deixar o projeto mais organizado e recebendo contribuições relevantes.
Adicione issues
Se você já tem uma ideia de quais funcionalidades ou correções poderiam ser feitas no projeto, essa é uma boa forma de documentá-las. A comunidade pode escolher entre as issues disponíveis para desenvolvê-las. E, claro, as pessoas também podem criar novas issues para discussão da relevância da contribuição que a pessoa quer fazer. Assim, antes da pessoa ter todo o trabalho de fazer a alteração, vocês chegam num acordo se aquela alteração faz sentido ou não.
Disponibilize o CODE_OF_CONDUCT.md do projeto
Pode ser legal ter um arquivo com o código de conduta, assim as pessoas sabem como contribuir da melhor forma para aquele projeto, entendendo quais são as regras. Basicamente, adicionando as orientações de se manter o respeito nas contribuições e nas discussões dessas contribuições, entre outras.
E você, tem mais dicas de como deixar o projeto o mais amigável possível para as pessoas saberem como contribuir com ele? Deixe nos comentários a sua contribuição!
Top comments (4)
Nos meus projetos eu costumo deixar configurado o dev container, assim quem quiser mexer no projeto poderá ter o ambiente de desenvolvimento, com todas as ferramentas necessárias, configurado automaticamente dentro de um contêiner docker, bastando para isso só pedir para um editor com suporte que abra o projeto dentro do contêiner.
Outra coisa que configuro são linters e testes, assim quando alguém fizer alguma alteração poderá executar essas ferramentas e rapidamente ter um retorno se a alteração está de acordo com o estilo de código esperado para o projeto, e se não quebrou nenhuma funcionalidade já existente.
Dessa forma eu entrego um ambiente para mexer no projeto, e uma validação mínima da alteração.
Perfeito, obrigada por contribuir com o conteúdo!
Maneiro! Tem indicação de algum OS contribuir?
Acho que depende muito, mas uns projetos iniciantes legais para contribuir são: