Contributing

O primeiro passo para contribuir com o projeto é encontrar issues abertas que você deseje contribuir. Caso não encontre nenhuma issue que te agrade, você pode abrir uma nova issue para discutir sobre a funcionalidade que você deseja implementar, utilizando a label feature request.

Lembrando, antes de abrir uma nova issue, verifique se já não existe uma issue aberta com o mesmo propósito. Além disso, há um Código de Conduta que deve ser seguido por todos os contribuidores do projeto.

Desenvolvimento

O fluxo pode ser diferente caso você seja um contribuidor externo ou um contribuidor interno.

Padrão de commits

Para padronizar os commits, deve-se utilizar a seguinte estrutura (#NmrCommit) Mensagem do commit, onde NmrCommit é o número da issue que está sendo resolvida e Mensagem do commit é uma mensagem que descreve o que foi feito no commit. A mensagem do commit deve ser escrita em português.

Contribuidores internos

Para contribuir com o projeto, você deve seguir o fluxo a seguir:

1. Atribuir a issue a si mesmo;
2. Caso não exista, criar uma branch específica para a issue, mantendo o nome sugerido;
3. Copiar os comandos e executar no terminal;
4. Atualizar estado da issue para In Progress no project;
5. Desenvolver a funcionalidade na nova branch;
6. Atualizar estado da issue para Done no project;
7. Realizar o pull request para a branch main do projeto.

Contribuidores externos

Para contribuir com o projeto, você deve seguir o fluxo a seguir:

1. Criar uma fork do projeto;
2. Abrir um pull request em draft para a branch main do projeto.
3. Desenvolver a funcionalidade no fork do projeto;
4. Realizar o pull request para a branch main do projeto.
5. Aguardar a revisão do pull request.