Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

56 lines (35 loc) · 3.09 KB
Raw

Como contribuir para o Meetup Cookbook do PUG-PE?

Primeiramente, muito obrigado por estar pensando em contribuir! 😄😄

Neste documento é apresentado um conjunto de diretrizes de como contribuir à este projeto. Essas diretrizes não são exatamente regras, mas seguí-las ajuda todo mundo a estar na mesma sintonia. Se quiser submeter um pull request para este documento, sinta-se à vontade. No geral, use o bom senso 😋.

Código de Conduta

Este projeto e todos que estão participando dele estão sujeitos ao código de conduta. Ao participar, é esperado que você também o siga e concorde com ele.

Como posso contribuir?

Sugerindo melhorias

Antes de sugerir, por favor veja se a mesma idéia já não foi sugerida antes. Caso a sua idéia tenha sido sugerida, não se esqueça de interagir na issue e ajudar a evoluir a idéia.

Como submeter uma boa sugestão de melhoria?

As melhorias tomam forma de Github Issues.

  • Use um título claro e descritivo;
  • Providencie uma descrição detalhada da sugestão;
  • Explique o porquê desta melhoria ser útil;
  • Descreva um antes e depois, se aplicável;
  • Providencie exemplos, se aplicável.

Implementando melhorias

Após dar uma olhada nas melhoridas já sugeridas, você viu que poderia implementar algumas delas? Você está na seção certa!

Criando Pull Requests

Com os Pull Requests (ou PR) você poderá integrar o que você desenvolveu com o nosso projeto.

Para isso, por favor siga os passos a seguir para que sua contribuição seja avaliada:

  1. Siga as instruções do modelo de pull requests ao criar um;
  2. Siga os guias de estilo

Os pré-requisitos acima serem seguidos não significa que os mantenedores do projeto não possam pedir adições ao pull request, esclarecimento de informações, mudanças em alguns trechos, etc., antes da contribuição ser aceita.

Guias de estilo

Mensagens de commit do git

  • Use a segunda pessoa do Imperativo Afirmativo ("Adiciona guias de contribuição..." e não "Adicionando guias de contribuição...");
  • O título (primeira linha) deve conter 50 caracteres ou menos
    • Escreva mensagem de commit objetiva sobre o que aquele commit muda no projeto.
    • Tente responder "O que este commit faz?";
  • Caso haja descrição do commit, deixe a segunda linha em branco;
  • Adicione uma descrição do commit da terceira linha em diante, com 72 caracteres ou menos por linha;
    • Ao se perguntar se é necessária uma descrição para o commit, se pergunte se alguém quiser investigar o "porquê desta mudança ter sido introduzida", será possível apenas pelo título e conteúdo do commit;
    • Adicione uma descrição que responda a pergunta "Por que este commit é necessário?";
  • Referencie issues ou pull requests no fim da mensagem;

Obrigado! ❤️ ❤️ ❤️