Como gerar uma mensagem de commit Git com tipo, âmbito e alteração incompatível

Para que serve

O Git Commit Generator serve para criar uma mensagem de commit Git formatada a partir de alguns dados opcionais. Pode fornecer um tipo de commit, um âmbito, uma mensagem e indicar se existe uma alteração incompatível. Também pode deixar estes campos de texto vazios e permitir que a ferramenta escolha valores ou construa o texto por si.

Como gerar a mensagem

Defina o resultado que pretende. Pode preencher o tipo de commit, o âmbito e a mensagem, além de ativar ou desativar a opção de alteração incompatível. Os campos de texto são opcionais e começam vazios; essa opção começa desativada.
Introduza um tipo reconhecido no campo correspondente. Quando o tipo fornecido é reconhecido, a ferramenta utiliza-o. Se o deixar vazio ou não fornecer um tipo reconhecido, escolhe um tipo de um conjunto incorporado.
Preencha o âmbito se quiser associar o commit a uma área do projeto. Um âmbito não vazio é colocado entre parênteses. Se o âmbito ficar vazio, a ferramenta escolhe um âmbito de um conjunto incorporado.
Escreva a mensagem que quer usar. Uma mensagem não vazia é utilizada como texto da mensagem. Se deixar este campo vazio, a ferramenta escolhe aleatoriamente um modelo e termos de listas incorporadas para construir o texto.
Ative a opção de alteração incompatível quando essa indicação fizer parte da mudança. Nesse caso, o resultado acrescenta uma linha em branco e um aviso de alteração incompatível ao texto gerado.
Execute a geração e leia o resultado antes de o aplicar no seu fluxo de trabalho. O resultado é uma mensagem de commit formatada; a ferramenta não está demonstrada como executando comandos Git, editando um repositório ou criando o commit.
Se o processamento falhar, verifique a informação apresentada. Quando ocorre uma exceção durante o processamento, a ferramenta comunica a falha e inclui o texto da exceção.

Como interpretar o resultado

Um resultado com valores fornecidos deve refletir os dados introduzidos: um tipo reconhecido é preservado, um âmbito preenchido aparece entre parênteses e uma mensagem não vazia é usada como texto. Quando a opção de alteração incompatível está ativa, procure também a linha em branco e o aviso acrescentados. Em qualquer caso, o texto termina com uma linha em branco seguida de três linhas fixas com marcadores.

Se deixar campos vazios, partes do resultado podem variar entre gerações, porque o tipo, o âmbito ou os elementos da mensagem podem ser escolhidos a partir de conjuntos incorporados. Por isso, um resultado gerado automaticamente deve ser revisto quanto ao contexto do seu repositório antes de ser utilizado. A ferramenta gera o texto, mas não há indicação de que valide se a mensagem é adequada, completa ou compatível com as regras específicas do seu projeto.

Exemplo prático

Está a preparar uma alteração no cálculo do total da área de pagamentos e quer assinalar que existe uma alteração incompatível.

Na ferramenta, introduza o âmbito “pagamentos”, escreva “corrige cálculo do total” como mensagem e ative a opção de alteração incompatível. Depois, execute a geração e consulte o texto apresentado.

O resultado contém o âmbito entre parênteses, utiliza a mensagem fornecida, inclui uma linha em branco e um aviso de alteração incompatível e termina com três linhas fixas com marcadores.

Limitações

A ferramenta gera texto, mas a informação disponível não demonstra que execute comandos Git, altere um repositório ou crie um commit, nem garante que a mensagem seja adequada às regras do seu projeto.

Erros comuns

Deixar a mensagem vazia e esperar um texto previamente definido pode produzir um resultado diferente do pretendido, porque a ferramenta constrói a mensagem a partir de um modelo e de termos escolhidos aleatoriamente. Introduza a mensagem pretendida para controlar esse conteúdo.

Perguntas frequentes

Posso fornecer a minha própria mensagem de commit?

Sim, mas apenas quando fornecer uma mensagem não vazia: nesse caso, ela é utilizada como texto. Com a mensagem vazia, o texto é construído a partir de modelos e termos escolhidos pela ferramenta.

Como é tratado o âmbito do commit?

Quando o âmbito não está vazio, é colocado entre parênteses. Se o deixar vazio, a ferramenta escolhe um âmbito de um conjunto incorporado.

O que acontece quando ativo a alteração incompatível?

Ao ativar essa opção, o resultado acrescenta uma linha em branco e um aviso de alteração incompatível ao texto gerado.