Skip to content

Latest commit

 

History

History
161 lines (124 loc) · 7.77 KB

CONTRIBUTING.md

File metadata and controls

161 lines (124 loc) · 7.77 KB
Raw

Guia de contribuição

Que bom que você resolveu contribuir conosco, obrigado ❤️! Neste guia vamos explicar como funcionam os nossos processos internos e como podemos trabalhar juntos da melhor forma possível.

Como contribuir

Existem diversas formas de contribuir com o projeto:

Reportando bugs

Se encontrou um bug você pode reportá-lo usando a ferramenta de issues do GitHub. Porém antes de enviar seu bug é importante fazer as seguintes verificações:

  1. Atualize seu repositório local no branch master mais recente. Talvez seu bug já tenha sido corrigido na versão mais recente;
  2. Verifique se o bug já foi reportado por outra pessoa fazendo uma busca pelas issues.

Se o bug realmente não foi resolvido ou acolhido então está na hora de criar uma nova issue. No título da issue tente resumir da melhor forma o problema evitando títulos genéricos como "Falha no sistema" ou "Problemas na instalação".

Se possível inclua imagens ou vídeos à descrição do bug para facilitar o processo de reprodução. Use um software como LICEcap para criar um gif animado de sua tela. Informe também detalhes sobre o seu ambiente: plataforma de execução, sistema operacional, navegador e versão, etc. Você também deve adicionar o label bug à issue, se esta opção estiver disponível.

Nota sobre falhas de segurança

Se você encontrou alguma falha de segurança não use as issues para reportar o bug. Escreva o seu report via e-mail diretamente para algum administrador do projeto. Ele será analisado, validado e corrigido de acordo com as necessidades. Pedimos que não torne a falha pública para segurança de todos que utilizam o projeto em seu estado atual.

Indicando melhorias

Outra ótima forma de contribuir é indicando melhorias ao código do projeto e em como ele está estruturado. Se você tem qualquer ideia de como podemos melhorar alguma abordagem na solução de problemas, refatoração de código, melhoria em algum recurso ou qualquer outra coisa relacionada, siga estes passos:

  1. Certifique-se de que sua ideia já não esteja sendo abordada em nosso roadmap;
  2. Também verifique se a ideia já não está pressente em nossas issues do GitHub;
  3. Defenda a sua ideia e explique de forma convincente porque ela deve ser acolhida. Eis algumas questões a considerar:
    1. Você realmente esta propondo uma ideia só ou um conjunto de ideias?
    2. Qual é o problema que sua ideia resolve?
    3. Por que sua sugestão é melhor do que o que já existe no código?
    4. Realmente vale a pena demandar tempo para implementar sua ideia dentro de nossas prioridades?

Tendo passado pelo crivo de todos estes questionamentos basta criar uma nova issue descrevendo as melhorias e usando o label feature ou melhoria, se esta opção estiver disponível.

Pedindo funcionalidades

Tendo em vista o que estamos construindo junto com a comunidade, novas funcionalidades tem prioridade relativa. Vale a pena enviar sua sugestão de funcionalidade apenas se:

  1. O recurso em questão resolve um problema que não é resolvido por nada que já exista no projeto;
  2. O recurso resolve um problema real validado por pessoas que estão em contato direto com a utilização do projeto.

Para criar seu pedido de funcionalidade criar uma nova issue usando o label feature, se você puder adicionar labels.

Discutindo as issues

Antes de partirmos para o código em si é muito importante discutirmos com a comunidade como cada issue será abordada. Toda e qualquer questão deve ser colocada em discussão para que qualquer pessoa que deseje solucionar aquele problema tenha o máximo de informações para executar uma solução.

Idealmente todas as issues devem ter um plano de ação claro antes que qualquer código seja escrito. Sabemos que muitas vezes isto não é possível, sendo necessário explorar e analisar melhor o que foi indicado. Nestes casos, publique todas as suas descobertas nas discussões indicando caminhos e recebendo o feedback da comunidade a respeito do que está sendo proposto.

Issues que estão em processo de discussão devem receber o label discussão indicando que aquela issue precisa dos inputs e feedbacks dos membros da comunidade. Nós te encorajamos a participar o máximo possível mas fique atento ao nosso código de conduta antes de realizar qualquer interação com os outros membros da comunidade.

Fazendo pull requests

Depois de ter um plano de ação relativamente claro você deve estar pronto para contribuir com código. Para isso faça um fork do projeto e trabalhe em cima de um branch diferente de master implementando suas soluções. Para saber mais sobre pull requests e como eles funcionam, veja este link.

Antes de abrir seu PR (pull request) certique-se que:

  • O código realmente resolve um problema real (de preferência baseado em alguma issue levantada);
  • Seu PR resolve uma issue apenas. Se você quiser fazer mais de uma coisa, divida em vários PRs;
  • Seu código é funcional (ou algo próximo disso). Providencie testes se possível;
  • As mensagens de seus commits são claras e descrevem bem o trabalho. Para maiores dicas sobre como escrever mensagens de commit adequadas, veja este guia.

Outras formas de contribuir

Se você não trabalha com código mas quer ajudar o projeto, existe muitas outras formas de contribuir:

  • Ajude com a documentação do projeto;
  • Fale sobre o projeto nas suas redes sociais, blogs, etc. Espalhe a palavra;
  • Organize eventos e dê palestras sobre o projeto;
  • Crie material promocional como apresentações, screencasts, mídia para compartilhamento em redes sociais, etc;
  • Viu alguma discussão que te interessa e onde você pode acrescentar mesmo sem conhecimento técnico? Não se acanhe e participe também nas issues do GitHub.

Pensou em alguma outra forma de contribuir? Compartilha com a gente!

Crie postagens

Postagens são formas de compartilhar seu conhecimento com a comunidade. Esta é uma ótima forma de contribuir e não é necessário entender muito de código!! basta criar um arquivo no formato AAAA-MM-DD-título.md (ex.: 2020-06-29-minha-experiencia-em-x-y-z.md) dentro da pasta _posts/postagens do repositório do site, fazer um pull request, e pronto. Seu texto estará disponível no site assim que for aprovado. Para mais informações verifique este link.

Créditos

Este documento foi escrito com o auxílio de outros documentos similares utilizados em outras comunidades. Destacamos:

... dentre outros!