exemplo

exemplo

Boas Praticas

- O nome do Repositório precisa ter o mesmo nome do Projeto. Exemplo: "Projeto siga"

• Todo arquivo README precisa informar:

  • Visão geral do Projeto

  • As tecnologias utilizadas

  • Como instalar ou utilizar esse projeto

  • Quem contribuiu ( A equipe)

  • Como pode contribuir ( comunidade externa que visualiza esse repositorio PUBLICO)

  • /src -> A pasta indicada para colocar o código fonte do projeto

  • /test -> A pasta é indicada para colocar os testes unitários

  • /public -> A pasta é indicada pra colocar o Front-End ou qualquer arquivo que precisa ficar a nível Público . A nível de API, teriamos os ENDPPINTS (rotas de Acesso)

  • /config -> (ou scripts) arquivos de configuração ou instalação de bibliotecas do projeto (isso também pode ficar na raiz do projeto) - config é uma pasta opicional

  • /docs -> A pasta é indicada para guardar imagens ou docs relacionados ao projeto,. Por exemplo: DIagramas , fluxoramas, Mapas Mentais, Canvas e etc.

  Utilizar boas práticas em commits

  • commits atomicos : realizar commits pequenos -> a unidade de trabalho

  • commit semantico: É informar com sufixo e em poucas palavras o que foi realizado nessa unidade de trabalho.

  Na raiz do projeto

  Commits

  [FEAT] adicionar algo [FEATCODE] adicionar algum codigo teste