Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

27 lines (20 loc) · 1.07 KB

Contribuição ao projeto

Agradeço muito o interesse de apoio ao projeto. Para uma contribuição saudável e inclusiva, devemos manter um padrão de execução.

Como começar a contribuição

  1. Crie uma issue explicando o problema e o desejo de alteração;
  2. Após receber um retorno validando o problema e permitindo a alteração, faça um novo fork do repositório;
  3. Implemente as mudanças ou novas funcionalidades que deseja realizar em seu fork;
  4. Crie um novo pull request para a branch develop do repositório oficial.

Padrões de projeto

  • Todas as variáveis e nomes de funções devem estar em camelCase;
  • Todas as classes devem estar em PascalCase;
  • Todas as entidades devem seguir o padrão:
    1. Uma pasta para cada entidade;
    2. Um arquivo para cada rota disponibilizada em relação aos envios/retornos;
    3. Um arquivo principal de declaração e utilização da entidade;
    4. Teste unitário de cada chamada.

Mensagens de commits

Siga o padrão conventional commits.