Padrão de Projeto e Acompanhamento

Os seguintes padrões deverão ser seguidos para desenvolvimento do projeto:

  • Deverá ser criada uma branch para cada module (Ex: feat/nome-do-module).

  • Todo o projeto deverá ser feito em Inglês.

  • Os modules serão nomeados no plural e em letras minúsculas (Ex: products, categories).

  • Nome de DTOs e Enums deverão estar no singular.

  • Se houver mais de uma frase no nome do DTO e Enums, a frase deverá ser escrita na forma dash-case (Ex: product-request.dto)

  • Métodos serão nomeados segundo o padrão lowerCamelCase.

  • Classes, Tipos e afins serão nomeados segundo com o padrão UpperCamelCase.

  • Sempre que houver manutenção no código, deverá ser realizado commit utilizando o padrão Karma (Ex: feat(nome-do-module): Adds message).

O diretório Utils, localizado no projeto, conterá funções pertinentes as formatações, rotinas e demais operações da API.

Versões, códigos e commits poderão ser revisados e alterados, portanto, caso seja necessário entraremos em contato.

Obrigado e seja bem vindo(a)!

Last updated

Was this helpful?