Pular para conteúdo

Contribuição para o projeto

Seja bem vindo e obrigado por considerar contribuir para o projeto de código aberto! São pessoas como você que tornam a vida de nossos usuários melhor.

Ler e seguir as orientações ajuda a tornar o processo de contribuição fácil e eficaz para todos os envolvidos.

Por onde começar

As contribuições são realizadas através de Issues e Pull Requests(PRs). Antes de criar uma nova issue ou PRs pesquise se já não existe uma solicitação existente para o mesmo problema ou funcionalidade.

Issues

Utilizado para relatar problemas com a aplicação, solicitar novas funcionalidades ou discutir alterações antes da criar PRs. Uma boa descrição da questão vai nos auxiliar bastante no entendimento do sua solicitação.

Pull Requests

Utilizado para corrigir ou adicionar funcionalidades. Adicionar ou alterar testes de unidade ou de integração para as funcionalidades. Incluir ou melhorar documentação.

Seguimos o fluxo de trabalho do Git "fork-and-pull" Git workflow

  1. Faça um fork do repositório para sua conta Github
  2. Clone o projeto para sua máquina
  3. Crie um novo branch local com um nome sucinto porém descritivo
  4. Realize as padronizações, formatações e testes necessários
  5. Faça um commit das alterações para a branch local
  6. Realize um push para o seu fork
  7. No seu fork na branch criada clique em "Compare e pull request".
  8. E em Create a pull request.
  9. Aguarde a análise e o junção da PRs.