Skip to content

Latest commit

 

History

History
47 lines (39 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

47 lines (39 loc) · 2.43 KB

Contributing

Obrigado por considerar contribuir para o nosso projeto!

Antes de começar, por favor, leia este documento para entender como colaborar de forma efetiva.

Como contribuir

  1. Crie um fork do projeto
  2. Clone o fork criado em sua máquina local
  3. Crie uma branch para sua contribuição: git checkout -b minha-contribuicao
  4. Realize as alterações em sua branch
  5. Teste as alterações localmente
  6. Faça um commit com uma mensagem clara e descritiva: git commit -m "Adiciona funcionalidade X"
  7. Faça o push da branch para o seu fork: git push origin minha-contribuicao
  8. Abra um pull request para a branch master do repositório original e aguarde a revisão da sua contribuição. Certifique-se de que seu pull request siga as seguintes políticas:
    • Cada pull request deve conter apenas uma funcionalidade ou correção de bug.
    • A mensagem de commit deve ser descritiva e objetiva.
    • O pull request deve ter pelo menos um revisor antes de ser mesclado.

Regras de contribuição

Para manter a qualidade do projeto, pedimos que você siga as seguintes regras ao contribuir:

  1. Escreva código claro e bem documentado
  2. Siga as boas práticas de programação recomendadas para a linguagem e/ou framework utilizado
  3. Teste o código antes de enviar a contribuição
  4. Cada pull request deve conter apenas uma funcionalidade ou correção de bug.
  5. A mensagem de commit deve ser descritiva e objetiva.

Política de commits

Regras para efetuar um commit no repositório:

  • Commits devem ser redigidos em português no gerúndio.
  • Devem ser simples e concisos, possuindo títulos curtos.
  • Devem ser compostos por (#NUMERO_DA_ISSUE) + Mensagem.
  • Exemplo: (#26) Criando componente menu

Política de branch

Ao criar branches, siga os padrões de nomenclatura apropriados:

  • Para branches de features, utilize o padrão feature/nometal.
  • Para branches de correção de bugs, utilize o padrão fix/nometal.
  • Para branches de documentação, utilize o padrão docs/nometal.
  • Para outras branches, siga a convenção apropriada para o tipo de alteração.

Bugs e problemas

Se você encontrar um bug ou tiver algum problema com o projeto, por favor, abra uma issue detalhando o problema encontrado. Nós ficaremos felizes em ajudar e solucionar o problema.

Licença

Ao contribuir para o projeto, você concorda que sua contribuição será licenciada sob a mesma licença do projeto original.