Skip to content

Latest commit

 

History

History
79 lines (47 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

79 lines (47 loc) · 3.12 KB
Raw

Como contribuir

Faça um Fork do projeto

Faça um fork do projeto para sua conta do GitHub e clone para sua máquina.

Crie uma branch para sua contribuição

Crie uma branch com um nome significativo para sua contribuição.

dicas:

  • digamos que você queira adicionar uma nova função, então você pode criar uma branch com o nome feature/nova-funcao.

  • digamos que você queira corrigir um bug, então você pode criar uma branch com o nome bug/corrigir-bug.

  • digamos que você queira melhorar a documentação, então você pode criar uma branch com o nome docs/melhorar-documentacao.

Commits e mensagens de commit

Convecções de commits e mensagens de commit: Conventional Commits

dicas:

  • Commits devem ser pequenos e resumidos.

  • Commits devem ser escritos no imperativo, ou seja, como se estivesse dando um comando. Exemplo: "Adiciona feature" e não "Adicionando feature" ou "Adicionada feature".

  • Commits devem ser escritos no presente, ou seja, como se estivesse acontecendo agora. Exemplo: "Adiciona feature" e não "Adicionou feature".

  • Commits devem ser escritos no singular, ou seja, como se estivesse falando de uma única coisa. Exemplo: "Adiciona feature" e não "Adiciona features".

  • Commits devem ser escritos com a primeira letra maiúscula. Exemplo: "Adiciona feature" e não "adiciona feature".

  • Commits devem ser escritos com um ponto final no final da mensagem. Exemplo: "Adiciona feature." e não "Adiciona feature".

  • Commits devem ser escritos com uma mensagem descritiva. Exemplo: "Adiciona feature." e não "Adiciona.".

Mensagens de commit exemplos

  • feat: adiciona nova feature
  • fix: corrige bug
  • docs: atualiza documentação
  • style: formatação, ponto e vírgula faltando; não altera código
  • refactor: refatoração de código
  • perf: melhora performance
  • test: adiciona ou corrige testes
  • chore: atualiza dependências
  • revert: desfaz commit anterior
  • build: alterações que afetam o sistema de build ou dependências externas (ex.: gulp, broccoli, npm)
  • ci: alterações nos arquivos e scripts de configuração de CI (ex.: Travis, Circle, BrowserStack, SauceLabs)

Abrindo uma issue

Você deve normalmente abrir uma issue nas seguintes situações:

  • Reportar um erro que.
  • Discutir um tópico de alto nível ou ideia (por exemplo, comunidade, visão ou políticas)
  • Propor uma nova função ou outra ideia do projeto.

Se você abrir uma issue para reportar um erro, por favor inclua o máximo de detalhes possíveis.

Enviando uma pull request

Você deve normalmente enviar uma pull request nas seguintes situações:

  • Corrigir um erro.
  • Adicionar uma nova função.
  • Melhorar a documentação.

Se você enviar uma pull request para corrigir um erro, por favor inclua o máximo de detalhes possíveis.

Código de conduta

Este projeto e todos os que participam dele estão sujeitos ao Código de Conduta. Ao participar, você concorda com suas diretrizes.

Licença

Este projeto está licenciado sob a licença MIT - veja o arquivo LICENSE para mais detalhes.