Boas práticas na hora do commit Para fácil identificação e resolução de problemas adotaremos o seguinte padrão para todos os commits. Ações básicas - obrigatórias: [ADD] - Sempre que adicionar arquivos, métodos em classes, funções, recursos, ou seja, tudo que for novo deverá ser informado. [ADD]
- wsException:
- Adicionado Método identificador de Código de Erro.
- Adicionado Método que Obtém o BackTrace.
- wsMessage:
- Gerenciamento Mensagens exibidas: Erros, Alertas e Informações. [WORK] - Quando você ainda está trabalhando. [WORK]
- tranking_usuario:
- Criando método de traking das ações dos usuários. [UPDATE] - Sempre que melhorar arquivos, métodos em classes, funções, recursos, ou seja, tudo que for melhoria ou Manutenção Evolutiva deverá ser informado. [UPDATE]
- Posicionamento do Menu.
- Ícone das Mensagens de: Erros, Alertas e Informações.
- Módulo NovoUsuario:
- Ajustado ao Code Standards.
- Finalizado a Documentação. [DEL] - Sempre que remover arquivos, métodos em classes, funções, recursos, ou seja, tudo que for removido deverá ser informado, para toda remoção deve haver uma justificativa. Seguindo o template: O que foi deletado?, Qual motivo?. [DEL]
- Módulo "teste", depreciado e desnecessário no sistema.
- Arquivos CSS, desnecessários.
- Config do login, passou para o config geral. [PATCH] - Sempre que corrigir arquivos, métodos em classes, funções, recursos, ou seja, tudo que for correção ou Manutenção Corretiva deverá ser informado. Será um patch sempre corrigir algo que funcione, porém, de forma incorreta. [PATCH]
- Corrigido cálculo de frete.
- Correção no nome dos templates nos módulos: produto e categoria.
- Corrigido problema na validação do login.
[MERGE] - Quando for feito um merge, que necessita de sua mediação para resolver. Seguindo o template: Qual origim? Qual destino? E o que foi feito.
[MERGE]
- UNIAO para HOMOLOGA.
- Merge no formulário de recuperação de senha. Ações extras - necessárias(seria bom se estivesse): [INFO] - Sempre que for necessário informar alguma notícia, seja ela uma Mudança de ação/estratégia, Inicio/fim de uma Roadmap/Versão ou mesmo modificações no Padrão. [INFO]
- Modificado padrão de codificação de ISO8859-1 para UTF-8
- Versão 2.0 beta em UTF-8
- Roadmap Finalizada.
- Nova Branch será iniciada. [TODO] - Sempre que houver algo para fazer: métodos em classes, funções, recursos, documentação, ajustes, ou seja, toda tarefa pendente poderá ser informado. [TODO]
- Finalizar documentação do Método: checkDimension da Classe: ImageFileUpload.
- Testar Formulário: Cliente [Novo]. [BUG] - Sempre que falhar arquivos, métodos em classes, funções, recursos, ou seja, tudo que impedir o pleno funcionamento deverá ser informado. OBS: Será usado os incidentes(issues) do bitbucket. [BUG]
- Ao Inserir a 2ª imagem do produto, aparece uma mensagem de erro: "Tentativa Inválida!", e o sistema volta para o login.
- Ao acessar: Solicitar Senha, a tela fica em branco até exceder o tempo de requisição. [FIX] - Sempre que fixar/corrigir um BUG e voltar ao pleno funcionamento como estava previsto, deverá ser informado. OBS: para resolver automáticamente incidentes abertos usar o o número do ticket exemplo: ler mais [FIX]
- Fixado o Bug ao tentar inserir a 2ª imagem do produto #5.
- Fixado o Bug ao Solicitar Senha #6.
Conclusão Resumindo o Padrão: Adicionou? ADD. Trabalhando? WORK. Removeu? DEL. Melhorou? UPDATE. Corrigiu algo que funcionava, porém, incorretamente? PATCH. Fez merge que necessitou da sua mediação? MERGE. Informações ou Notícias? INFO. Deixou algo pendente para ser feito? TODO. Falhas que impedem alguma funcionalidade? BUG. Corrigiu algum bug? FIX.