| Ambos lados da revisão anterior Revisão anterior Próxima revisão | Revisão anterior |
| pres:gerti:devops:informacoes:nomenclatura_commits [20/04/2026 11:31] – lvinicius | pres:gerti:devops:informacoes:nomenclatura_commits [07/05/2026 12:59] (atual) – [Sintaxe dos Commits] ivinicius |
|---|
| |
| Adotamos o padrão [[https://www.conventionalcommits.org/pt-br/v1.0.0/|Conventional Commits]], o qual inicia o commit com um prefixo como ''%%fix:%%'', ''%%feat:%%'', ''%%docs:%%'' para identificar o tipo da mudança. | Adotamos o padrão [[https://www.conventionalcommits.org/pt-br/v1.0.0/|Conventional Commits]], o qual inicia o commit com um prefixo como ''%%fix:%%'', ''%%feat:%%'', ''%%docs:%%'' para identificar o tipo da mudança. |
| |
| É importante utilizar esse padrão pois os repositórios possuem (devem possuir) um [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates/-/tree/main/templates/versioning|Job de Versionamento]] na Pipeline de CI/CD. Esse job gera automaticamente a tag da versão do repositório no padrão de [[pres:gerti:devops:informacoes:versionamento_semantico|Versionamento Semântico]] com base no nome dos commits. | |
| |
| Para mais informações, veja também o [[https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md|Guia de Commits do Angular]] que também usa o [[https://www.conventionalcommits.org/pt-br/v1.0.0/|Conventional Commits]]. | Para mais informações, veja também o [[https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md|Guia de Commits do Angular]] que também usa o [[https://www.conventionalcommits.org/pt-br/v1.0.0/|Conventional Commits]]. |
| * Tornar o histórico de commits mais legível | * Tornar o histórico de commits mais legível |
| * Padronizar a comunicação entre a equipe | * Padronizar a comunicação entre a equipe |
| | |
| | ==== Automatizar o versionamento ==== |
| | |
| | É importante utilizar esse padrão pois os repositórios possuem (devem possuir) um [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates/-/tree/main/templates/versioning|Job de Versionamento]] na Pipeline de CI/CD. Esse job lê o nome dos commits e gera automaticamente a tag da versão do repositório no padrão de [[:pres:gerti:devops:informacoes:versionamento_semantico|]]. |
| | |
| | {{:pres:gerti:devops:informacoes:20260420083356.png?nolink&1281x183}} |
| | |
| |
| ===== Sintaxe dos Commits ===== | ===== Sintaxe dos Commits ===== |
| |
| Esta é a sintaxe dos commits que o [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates/-/tree/main/templates/versioning|Job de Versionamento]] está configurado para entender | Esta é a sintaxe dos commits que o [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates/-/tree/main/templates/versioning|Job de Versionamento]] está configurado para entender |
| |
| <code> | <code> |
| <tipo>(<escopo opcional>): <descrição> [#<task redmine>] | |
| | <tipo>(<escopo opcional>): [ref #<task redmine> (exemplo: ref #40061 - para uma tarefa - ou refs #40061, #40062 - para duas ou mais tarefas)] <descrição> |
| </code> | </code> |
| |
| * ''%%<tipo>%%'': **Obrigatório.** Refere-se ao tipo da alteração: se ele corrige um bug é um ''%%fix%%'', se adiciona um feature, é um ''%%feat%%''. Veja: [[#Quais%20Tipos%20de%20Commits%20existem?|Quais Tipos de Commits existem?]] | * ''<nowiki><tipo></nowiki>'': **Obrigatório.** Refere-se ao tipo da alteração: se ele corrige um bug é um ''<nowiki>fix</nowiki>'', se adiciona um feature, é um ''<nowiki>feat</nowiki>''. Veja: [[#quais_20tipos_20de_20commits_20existem|Quais Tipos de Commits existem]] |
| * ''%%<escopo opcional>%%'': **Opcional.** Descreve qual módulo do sistema foi alterado | * ''<nowiki><escopo opcional></nowiki>'': **Opcional.** Descreve qual módulo do sistema foi alterado |
| * ''%%<descrição>%%'': **Obrigatório.** Descrição do o que o seu commit faz. Inicie sempre com verbos no **presente do indicativo**, ex.: ''%%corrige%%'', ''%%altera%%'', ''%%implementa%%'', ''%%refatora%%'', ''%%adiciona%%''. | * ''<nowiki><descrição></nowiki>'': **Obrigatório.** Descrição do o que o seu commit faz. Inicie sempre com verbos no **presente do indicativo**, ex.: ''<nowiki>corrige</nowiki>'', ''<nowiki>altera</nowiki>'', ''<nowiki>implementa</nowiki>'', ''<nowiki>refatora</nowiki>'', ''<nowiki>adiciona</nowiki>''. |
| * ''%%[#<task redmine>]%%'': **Opcional.** Este é o ID da task do Redmine caso seu commit esteja relacionado. Ex: ''%%#39042%%'' | * ''<nowiki>[#<task redmine>]</nowiki>'': **Opcional.** Este é o ID da task do Redmine caso seu commit esteja relacionado. Ex: ''<nowiki>#39042</nowiki>'' |
| |
| ==== Quais Tipos de Commits existem? ==== | ==== Quais Tipos de Commits existem? ==== |