diff --git a/commits.md b/commits.md new file mode 100644 index 0000000..b7da3ef --- /dev/null +++ b/commits.md @@ -0,0 +1,40 @@ +# 📝 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 + +``` +(optional scope): +``` + +# 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 \ No newline at end of file