Introdução
Inicialmente iniciei esse projeto apenas para praticar alguns conceitos que ando estudando, como restfull ou clean code, por exemplo. Contudo não estava afim de fazer simplismente um "Hello World", ai veio a idéia de montar um sistema de vendas de prateleira daqueles bem genéricos, afinal cansei de passar vergonha quando me perguntava se eu tinha um. Este primeiro módulo é o "core", onde se detem as principais funcionalidades do controle de estoque.
Iniciando no projeto
TODO: Informe aos usuários como executar o código em seu próprio sistema. Nesta sessão você pode explicar como:
- Processo de instação
- Dependencias do software
- Última versão
- API Referenciadas
Build and Testes
TODO: Descreva como buildar e executar os testes em seu projeto
- [Padrões e Processos para Criação e Projetos]
- [Git Commit Messages]
- [Padrões de versionamento/repositórios]
- [Versionamento de Projeto]
Padrão para formatação do código
Todos os desenvolvedores devem usar o padrão de formatação (Style Guide) do Google. Para automatizar esta formação, configure a IDE IntelliJ da seguinte maneira:
- Importe na IDE o XML (
File > Settings > Editor > Code Style > Java > ⚙ icon > Import Schema > IntelliJ IDEA code style XML
) que se encontra na subpastaconfig
projeto. Há versões para IntelliJ e Eclipse. - Habilite a organização automática de import (
File > Settings > Editor > General > Auto Import > Optimize imports on the fly
) - Passe usar a formatação de código, acesse o menu
Code
do IntelliJ ou utilize a tecla de atalhoCtrl+Alt+Shift+L
.
Analisador estático de código
Este projeto utiliza o plugin pmd do gradle para análise estática do código seguindo as regras de qualidade definida no arquivo config/custom-pmd-ruleset.xml
deste projeto. O processo de build irá falhar caso alguma dessas regras sejam violadas. Faça a verificação de qualidade com o comando gradle check
.