Página Inicial |
---|
Página da Arquitetura do Sistema
Esta é a página onde irá ficar todas as informações da Arquitetura do seu projeto, Como:
- Segurança
- Rotas de Backend (Arquitetura funcional)
- Objects – Backend API
- Methods – Backend API
- Arquitetura Não Funcional)
- Diagrama de Pacotes / Componentes (Arquitetura de software)
- Diagrama de Deploy
- Documentação sobre aplicação de Design do Projeto
- Análise dos principios SOLID
- Code Review
Devem ser apresentados das seguintes formas:
- Imagens ou Gifs
- Diagramas ou Sistemas
- Descrições ou Textos explicativos
Políticas do Git
Sobre mensagens de commit:
- Em inglês
- As mensagens devem estar no modo imperativo
- Utilizar mais ou menos 50 caracteres
- A mensagem sempre começa com letra maiúscula
- A mensagem não tem ponto final
- Sempre especificar o tipo de commit
- Usar o corpo da mensagem (quando necessário) para explicar "o que" e "por que"
Tipos de commits
- feature: Alterar comportamento, interface ou adicionar nova funcionalidade
- fix: Correção de bugs
- doc: Alteração da documentação, README, CHANGELOG, etc
- style: Formatação, ponto e vírgula faltando, mudanças de whitespace, estilo de código no geral
- refactor: Refatoração do código de produção, nenhuma ateração de funcionalidade ou comportamento
- test: Adicionar testes, refatorar testes; código de produção não é alterado
Exemplos
feature: Add search videos page
fix: Stop ignoring keywords when searching
doc: Add examples to the contributing guide
style: Remove empty line
refactor: Move related methods close together
test: Add spec for api video controller
Sobre branches:
- Master: é a base do projeto. É dela que as outras branches serão criadas. Onde ocorrerá o
merge
das branches de desenvolvimento. Utilizaremos Semantic Versioning para mantermos o controle de versão da nossa aplicação. - Branches de desenvolvimento: onde novas funcionalidades são desenvolvidas e erros são corrigidos. Lembrando que elas sempre são criadas a partir da
master
.