40 lines
1.0 KiB
Markdown
40 lines
1.0 KiB
Markdown
# 📝 Commit Messages
|
|
|
|
We follow the [Conventional Commits](https://www.conventionalcommits.org/) guideline for commit messages.
|
|
This helps keep our history clean and makes changelogs easier to generate.
|
|
|
|
# Format
|
|
|
|
```
|
|
<type>(optional scope): <description>
|
|
```
|
|
|
|
# Examples
|
|
|
|
```
|
|
feat(auth): add OAuth2 login
|
|
fix(ui): patch crash on empty input
|
|
docs(readme): update installation instructions
|
|
```
|
|
|
|
# Common Types
|
|
|
|
* **feat:** a new feature (may bump MINOR version)
|
|
* **fix:** a bug fix (may bump PATCH version)
|
|
* **docs:** documentation only
|
|
* **style:** formatting, whitespace, etc.
|
|
* **refactor:** code changes without behavior change
|
|
* **test:** add or update tests
|
|
* **chore:** maintenance (CI, build, tooling, assets)
|
|
|
|
👉 If your change introduces a **breaking change**, mark it with `!` or add a footer:
|
|
|
|
```
|
|
feat(api)!: remove legacy endpoint
|
|
|
|
BREAKING CHANGE: old /v1 endpoints were removed
|
|
```
|
|
|
|
---
|
|
|
|
⚠️ **Note:** This is a guideline, not a strict rule. If you forget, no worries — just try to follow the format when you can |