Skip to content

Commit

Permalink
docs: correct comments about feat/fix
Browse files Browse the repository at this point in the history
In semantic versioning, a feature leads to a minor release and a fix
leads to a patch release. This was stated incorrectly in comments
defining the corresponding types for feat and fix.

Signed-off-by: bernot-dev [email protected]
  • Loading branch information
bernot-dev committed Jan 29, 2024
1 parent 2feadaa commit 0d524ae
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions internal/policy/commit/check_conventional_commit.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ var HeaderRegex = regexp.MustCompile(`^(\w*)(\(([^)]+)\))?(!)?:\s{1}(.*)($|\n{2}

const (
// TypeFeat is a commit of the type fix patches a bug in your codebase
// (this correlates with PATCH in semantic versioning).
// (this correlates with MINOR in semantic versioning).
TypeFeat = "feat"

// TypeFix is a commit of the type feat introduces a new feature to the
// codebase (this correlates with MINOR in semantic versioning).
// codebase (this correlates with PATCH in semantic versioning).
TypeFix = "fix"
)

Expand Down

0 comments on commit 0d524ae

Please sign in to comment.