CONTRIBUTING.md

Contribuindo nesse projeto

Por favor, tire um momento para revisar esse documento para que seja possível contribuir de forma fácil e efetiva para todos os envolvidos.

Seguir esse guia ajuda a demonstrar que você respeita o tempo utilizado pelos desenvolvedores em gerenciar e desenvolver esse projeto. Como retorno, os desenvolvedores devem reciprocamente endereçar as issues do projeto.

Utilizando a lista de issues

A lista de issues é o canal preferido para relatar problemas, solicitar melhorias e enviar pull requests, mas por favor

Relatar problemas

Um problema é um problema demonstrável que é causado pelo código desse repositório. Um bom relatório do problema é extremamente útil - obrigado!

Guia para relatar problemas:

1. Procure pela issue — verifique se a issue já não foi relatada.

2. Verifique se a issue já não foi resolvida — tente reproduzir o problema utilizando o último master ou branch de desenvolvimento.

3. Isole o problema — crie um caso de teste reduzido.

Um bom relato de problema não deve deixar outros precisando te procurar para mais informações. Por favor, tente ser o mais detalhado possível em seu relato. Qual o seu ambiente? Quais são os passos para reproduzir? Que browser(s), sistema operacional, banco de dados, versões de componentes você utilizou? Qual é o resultado que você espera? Todos esses detalhes ajudarão as pessoas a corrigir tais problemas.

Exemplo:

Um título curto e um exemplo descritivo do problema

Um resumo do problema e os detalhes do ambiente em que ele ocorre. Se possível, inclua os passos para reproduzir o problema.

1. Primeiro passo
2. Segundo passo
3. Demais passos e etc.

<url> - um link para o caso de teste reduzido

Qualquer outra informação que você deseja compartilhar e que é relevante para a solução do problema. Isso pode incluir a linha do código que você identificou como o causador do problema e as soluções possíveis (e sua opinião sobre isso).

Solicitar melhorias

Solicitações de melhorias são bem-vindas. Porém, verifique se sua ideia está dentro do escopo e se segue o mesmo objetivo do projeto. Está em sua responsabilidade convencer os desenvolvedores do projeto sobre o mérito da sua solicitaçõ. Por favor, de a maior quantidade de detalhes possível.

Pull requests

Bons pull requests - correções e melhorias - são de extrema ajuda. Eles devem permanecer focados no escopo e evitam commits não relacionados.

Por favor, pergunte primeiro antes de iniciar qualquer pull request significante (exemplo: novas funcionalidades, refatoração de código, movendo para uma nova linguagem), caso contrário você estará arriscando gastar uma grande quantidade de horas trabalhando em alguma coisa que talvez os desenvolvedores do projeto não desejam juntar no projeto.

Por favor, aderir as convenções de código utilizados no projeto (indentação, comentários, etc.) e qualquer outro requerimento (como a cobertura de testes).

IMPORTANTE: Ao submeter uma alteração você está concordando em permitir que o dono do projeto licencie o seu trabalho dentro da mesma licença do projeto.