Skip to content

Como contribuir

As contribuições para o projeto podem ser feitas por meio de issues e pull requests, reportando bugs, sugerindo ou implementando novas funcionalidades ou melhorando a documentação. Para manter uma boa organização devem ser seguidas as dicas e padrões citadas nesse documento. Para mais informações sobre o projeto veja o README e o código de conduta.

Issues

As issues podem ser criadas para relatar problemas e sugerir melhorias.

  • Certifique-se que uma issue tratando do problema já não existe
  • A issue deve ser clara tanto no título quanto na descrição
  • Utilize as labels apropriadas para auxiliar na classificação da issue
  • Aguarde uma resposta dos mantenedores do repositório

Pull Request

  • O título e o comentário devem ser claros
  • As funcionalidades implementadas devem ter sido testadas e serem funcionais

Branches

  • A branch para adição de funcionalidade normalmente deve ser criada a partir da main
  • Use o nome feature/nomeDaFuncionalidade para a branch que adiciona a funcionalidade

Commits

  • Os commits devem ter títulos significativos
  • O título deve descrever com clareza o que foi alterado

Histórico de Versões

Data Versão Descrição Autor
30/06/2022 0.1 Versão inicial Ana Caroline