Skip to content

Commit c94e211

Browse files
committed
docs(commit): add docs to commit data structure
1 parent ecfc352 commit c94e211

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

internal/conventional/commit.go

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
package conventional
22

33
type (
4+
// Commit represents the components of a Conventional Commit message.
5+
// See https://www.conventionalcommits.org/ for the specification.
46
Commit struct {
5-
Type string
6-
Scope string
7-
Title string
8-
Body string
7+
// Type describes the kind of change (e.g., "feat", "fix", "docs").
8+
Type string
9+
// Type describes the kind of change (e.g., "feat", "fix", "docs").
10+
Scope string
11+
// Title is a short description of the change.
12+
Title string
13+
// Body is an optional longer description.
14+
Body string
15+
// Footer is optional metadata (e.g., "BREAKING CHANGE:", issue refs).
916
Footer string
1017
}
1118
)

0 commit comments

Comments
 (0)