O Github é cheio de funcionalidades e o mais utilizado isso vocês já sabem e vamos continuar a série de "hacks" da plataforma que vão otimizar e melhorar sua experiência.
⚠️ Importante: Os prints que serão exibidos para exemplificar podem estar diferentes da interface do seu GitHub, por que sou muito adepto a extensões que melhoram a usabilidade e que ajudam no meu dia a dia. Partindo desse ponto peço que dê uma olhada nesse artigo antes.
Contribuir para projetos open source é algo que nos faz crescer muito como profissionais. Temos a oportunidade de aprender coisas novas e praticar o que muitas vezes não utilizamos comumente no nosso dia-a-dia.
Cada pessoa que cria um projeto open source tem sua forma de escrever seus códigos, organizar a estrutura de arquivos, etc. Se o projeto é interessante, outras pessoas acabam ficando interessadas em contribuir. Mas a frustração vem quando descobrimos que cada um escreve seu código de uma forma: alguns usam tabs, outros espaços; uns preferem 4 espaços, outros preferem 2; colocar espaço entre o if e os () ou não, escrever o else em uma nova linha, ou na mesma linha do fechamento do } e assim por diante. Nenhuma destas formas estão erradas, São apenas diferentes modos de escrever o mesmo código! Mas se um mesmo código tiver várias dessas formas misturadas, o projeto vai acabar virando uma zona o famoso padrão sem padrão.
Então, normalmente colocamos no README.md do repositório uma área de como contribuir, citando os padrões que você utilizou no código, mostrando como criar uma nova feature, bugfix entre outras coisas. Mas no momento de empolgação, muitas vezes os devs nem chegam nessa parte do seu README.md (aposto que você mesmo já passou batido), e acabam enviando pull requests com seus próprios padrões.
O arquivo CONTRIBUTING.md
Uma feature bem simples do Github, mas que pode ajudar a organizar melhor a colaboração nos seus projetos e que poucos conhecem, é a adição de um arquivo chamado CONTRIBUTING.md. Nesse arquivo você coloca tudo o que a pessoa que vai colaborar com o seu projeto precisa saber e quando criamos esse arquivo, sempre que alguém for criar uma nova issue ou enviar um pull request, olha o que vai aparecer pra ele:
O guidelines for contributing que aparece na mensagem acima, é linkado diretamente com o nosso arquivo CONTRIBUTING.md! Assim, sempre que alguém for colaborar, ele verá esse aviso, e ainda que não leia o README.md, verá que existem alguns padrões a serem seguidos para que ele possa contribuir.
Fontes onde pesquisei esse conteúdo:
Top comments (0)