From 0be755d4e39bf3dd33e8485e4c665bf62270516f Mon Sep 17 00:00:00 2001 From: Kaede Akino Date: Thu, 24 Sep 2026 15:28:57 +0800 Subject: [PATCH] docs: adopt conventional commit guidelines --- AGENTS.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index d08c188c..c6a619c9 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -70,7 +70,23 @@ Put user-facing app text in `Frameworks/Resources/Localizable.xcstrings` and bun ## Commit & Pull Request Guidelines -Use short, imperative subjects such as `Fix Assistant sidebar navigation round-trip`; reserve `Bump to X.Y.Z` for releases. Keep commits focused. Always include `Scripts/check-zh-localization.sh` in the commit pipeline, even without intentional localization changes. PRs should describe the outcome, affected layers, verification, and issues. Include bilingual screenshots for UI changes when applicable. Never commit secrets, `.env` files, build products, or user-specific Xcode data. +Use Conventional Commits: `[optional scope]: `, with a lowercase type and a short, imperative English description (for example, `feat: add host groups` or `fix(assistant): restore sidebar navigation round-trip`). Choose the type that matches the change: + +- `feat`: new features. +- `fix`: bug fixes. +- `docs`: documentation-only changes. +- `refactor`: code restructuring without changing behavior. +- `perf`: performance improvements. +- `test`: test additions or updates. +- `style`: formatting-only changes without changing behavior. +- `build`: build system or dependency changes. +- `ci`: CI configuration or workflow changes. +- `chore`: maintenance that does not fit another type; use `chore(release): bump to X.Y.Z` for releases. +- `revert`: revert a previous commit. + +Mark breaking changes with `!` before the colon (for example, `feat(api)!: remove deprecated endpoint`) and explain the impact in a `BREAKING CHANGE:` footer. + +Keep commits focused. Always include `Scripts/check-zh-localization.sh` in the commit pipeline, even without intentional localization changes. PRs should describe the outcome, affected layers, verification, and issues. Include bilingual screenshots for UI changes when applicable. Never commit secrets, `.env` files, build products, or user-specific Xcode data.