Benutzer-Werkzeuge

Webseiten-Werkzeuge


it-wiki:git:conventional_commits

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
it-wiki:git:conventional_commits [2023/01/05 23:51] markoit-wiki:git:conventional_commits [2023/01/05 23:59] (aktuell) – alte Version wiederhergestellt (2023/01/06 00:51) marko
Zeile 6: Zeile 6:
 But, before talking about how to automatically create our changelogs I have to introduce you to the [[https://www.conventionalcommits.org/en/v1.0.0-beta.4/|conventional commits]] But, before talking about how to automatically create our changelogs I have to introduce you to the [[https://www.conventionalcommits.org/en/v1.0.0-beta.4/|conventional commits]]
  
-\\ 
 \\ \\
 The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history, which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history, which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
Zeile 12: Zeile 11:
 Commits will have a standard structure that serves to describe exactly what happened in that commit: Commits will have a standard structure that serves to describe exactly what happened in that commit:
  
-{{ :it-wiki:git:1_tzjli8vp6lnjqkkq92ygia.png?direct&300 |}}+{{ :it-wiki:git:1_tzjli8vp6lnjqkkq92ygia.png?direct&400 |}} 
 + 
 +or if you use the short version from your terminal: 
 +''git commit -a -m"<type>[optional scope]: <description>"'' 
 + 
 +Every commit has a **type** that falls into a predefined category, the specific categories are: 
 + 
 +  * ''feat'': introduces a new feature to the codebase (this correlates with a MINORin SemVer es: ''2.0.0'' -> ''2.1.0''). 
 +  * ''fix'': a bugfix in your codebase (this correlates with a ''PATCH'' in semVer es: ''2.0.0'' -> ''2.0.1''). 
 +  * ''BREAKING CHANGE'': is a total change of your code, this is also can be used with a previous tag like ''BREAKING CHANGE: feat: <description>'' (this correlates with a ''MAJOR'' in SemVer es: ''2.0.0'' -> ''3.0.0''). 
 +  * ''docs'': a change in the README or documentation 
 +  * ''refactor'': a change in production code focused on upgrade code readability and style 
 + 
 +The scope specifies what you have changed, preferably in a single word. 
 +The description is a one line that specifies what the change is. 
 + 
 +In [[https://weare.jobtome.com/|Jobtome]] we also use other types for the every-day usage like ''chore:'', ''test'': , ''optimization'':
it-wiki/git/conventional_commits.1672962671.txt.gz · Zuletzt geändert: von marko