Adicionar CONTRIBUTING.md

[luizffgv]

Eu sinto que esse repositório sofre com a falta de um CONTRIBUTING.md. Nosso próprio README tem uma seção sobre como contribuir—com orientações válidas—porém um CONTRIBUTING.md é mais adequado pra formalizar o que esperamos de uma issue ou pull request.

Uma coisa que já seria útil adicionar é a linguagem que devemos utilizar. Nossos commits iniciais foram em português e parece ter ocorrido uma mudança pra inglês no processo, mas nada formalizado. Isso atrapalha um pouco quem quer contribuir, ou até mesmo ler o histórico do repositório.

[tarcisiofischer]

Boa. Obrigado pelas sugestões, acho que são todas pertinentes. Posso sim adicionar um CONTRIBUTING.md. Informações que pretendo adicionar (se alguém tiver outras sinta-se livre pra sugerir). Quando vc diz "qual a linguagem que devemos utilizar", queres dizer o "tempo verbal" no livro?

• Bem vindo: Agradecimentos gerais e apresentação
• Como ajudar? Falar do fluxo de trabalho pra adicionar algo no livro
• Regras e linguagem: Regras de sintaxe, de escrita (tempo verbal, informalidade, etc), regras dos commits

O que achas?

[luizffgv]

@tarcisiofischer Essas ideias são boas. Se possível, seria bom também escolher algum formatador e um linter de Markdown pra todos usarem e deixar mais consistente. Eu pessoalmente uso Prettier pra formatar e Markdownlint pra verificar. Isso dá uma tarefa a mais pra todos que quiserem contribuir, mas talvez valha a pena. Fica a seu critério.

Um CONTRIBUTING.md meu como exemplo.

Também seria bom botar um aviso sobre utilizar apenas fontes confiáveis para contribuir.

Quando vc diz "qual a linguagem que devemos utilizar", queres dizer o "tempo verbal" no livro?

Nesse caso eu quis dizer a linguagem que usamos nas commit messages e PRs. Inglês vs. português.