You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: enhance commit message format documentation and add validation
- Expanded README with detailed conventional commit format explanation
- Added @commitlint/cli and @commitlint/config-conventional for validation
- Created commitlint.config.cjs with strict conventional commit rules
- Added commit-msg hook to automatically validate commit messages
- Added commitlint script to package.json for manual validation
- Documented importance of commit format for semantic versioning
Co-authored-by: 8enSmith <798183+8enSmith@users.noreply.github.com>
Copy file name to clipboardExpand all lines: README.md
+45-4Lines changed: 45 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -275,10 +275,51 @@ For the automated release workflow to function, the following secrets must be co
275
275
276
276
#### Commit Message Format
277
277
278
-
-`feat:` - new features (triggers minor version bump)
279
-
-`fix:` - bug fixes (triggers patch version bump)
280
-
-`feat!:` or `fix!:` - breaking changes (triggers major version bump)
281
-
-`docs:`, `style:`, `refactor:`, `test:`, `chore:` - no version bump
278
+
**⚠️ Important:** This project uses automated semantic versioning. The commit message format directly determines version bumps and changelog generation.
279
+
280
+
The project follows the [Conventional Commits](https://www.conventionalcommits.org/) specification. Each commit message must be structured as:
281
+
282
+
```
283
+
<type>[optional scope]: <description>
284
+
285
+
[optional body]
286
+
287
+
[optional footer(s)]
288
+
```
289
+
290
+
**Supported commit types:**
291
+
-`feat:` - new features (triggers **minor** version bump: 1.0.0 → 1.1.0)
0 commit comments