Documento explicando como contribuir com código

fititnt commented 8 years ago

CONTRIBUTING.md é um arquivo padrão, normalmente usado para dar uma ideia geral de como contribuir para um projeto, conforme explicado em https://help.github.com/articles/setting-guidelines-for-repository-contributors/.

Este PR sugere primeira versão dele. Aceito sugestões de melhoria

woliveiras commented 8 years ago

@fititnt, acho que seria interessante a inclusão de dicas de como mandar o Pull Request pra quem não manjar muito sobre GitHub.

Ex. do que eu sigo hoje:

Os commits devem conter descrição no imperativo
Os commits devem estar no idioma inglês
O contribuidor deve garantir que seu Pull Request seja testado por outra pessoa para não quebrar nada. Isso pode ser feito solicitando validação no comentário do PR.
Antes de enviar um PR, o contribuidor deve abrir uma issue e perguntar se é interessante adicionar o que ele tem em mente e coletar mais informações de como fazer isso

Fora isso, colocar algum link de posts/vídeos sobre Git/GitHub para iniciantes como esses:

Post sobre como contribuir: https://woliveiras.com.br/posts/contribuindo-para-projetos-open-source-no-github-mesmo-sendo-iniciante/
Curso de Git: http://willianjusten.teachable.com/courses/git-e-github-para-iniciantes

lapa182 commented 8 years ago

@woliveiras não esquecer de fazer um fork também 😋

woliveiras commented 8 years ago

Bem lembrado @lapa182 :smile:

fititnt commented 7 years ago

@woliveiras @lapa182 e outras pessoas aqui, agora vamos filosofar um pouco aqui, e pensar um pouco menos como profissionais mais experientes e metódicos e mais na forma de como parecer menos rígido para alguém iniciante.

Como podemos fazer reduzir o estresse e ansiedade de quem quer contribuir com código pra um projeto que não é ciência de foguetes, mesmo que isso signifique dar mais trabalho para os mantenedores do projeto?

Creio que vou abrir um issue apenas sobre isso.

pokemongovet / pokemongovet.github.io

Documento explicando como contribuir com código #19