docs: add Angular commit message format guidelines

fengmk2 · claude · fengmk2 · commit 5f0df8dc35e4 · 2025-09-14T08:34:25.000+08:00
Add comprehensive commit message format documentation to both CLAUDE.md and .github/copilot-instructions.md following the Angular convention specified in CONTRIBUTING.md. - Include required types, scope guidelines, and subject rules - Provide project-specific examples with actual package names - Emphasize importance for automated changelog and release processes - Ensure consistency across all development documentation This ensures all developers follow the established commit conventions for maintaining project consistency and automated tooling compatibility. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
@@ -223,3 +223,75 @@ After making changes, always verify:
 4. **Tests Run**: `pnpm run test` executes (some failures expected, focus on your changes)
 
 **Remember**: This is a complex enterprise framework. Always build first, validate incrementally, and focus on the core packages (`egg`, `core`, `utils`) for most development work.
+
+## Commit Message Format
+
+**CRITICAL: All commits MUST follow the [Angular Commit Message Format](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) as specified in CONTRIBUTING.md.**
+
+### Required Format Structure
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+### Mandatory Types
+
+- **feat**: A new feature
+- **fix**: A bug fix
+- **docs**: Documentation-only changes
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **perf**: A code change that improves performance
+- **test**: Adding missing tests
+- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
+- **deps**: Updates about dependencies
+
+### Scope Guidelines
+
+- **Package-specific changes**: Use package names like `core`, `mock`, `cluster`, `utils`, `tsconfig`, `extend2`
+- **Cross-package changes**: Use feature areas like `loader`, `plugin`, `config`, `build`
+- **Component-specific**: Use component names like `application`, `agent`, `context`
+
+### Subject Rules
+
+- Use imperative, present tense: "change" not "changed" nor "changes"
+- Don't capitalize first letter
+- No period (.) at the end
+- Be succinct and descriptive
+
+### Examples
+
+```
+feat(tsconfig): integrate package into monorepo with vitest
+
+Merge @eggjs/tsconfig repository into packages/tsconfig/ and refactor
+to use vitest testing framework instead of Node.js test runner.
+
+- Update all consuming packages to use workspace:* dependencies
+- Add vitest configuration and convert test assertions
+- Remove external catalog dependency in favor of workspace package
+
+Closes #123
+```
+
+```
+fix(core): resolve loader initialization race condition
+
+The loader was attempting to initialize plugins before configurations
+were fully loaded, causing intermittent startup failures.
+
+Fixes #456
+```
+
+```
+chore: update dependencies to latest versions
+
+Update catalog dependencies and rebuild packages to ensure
+compatibility with latest versions.
+```
+
+**NEVER commit without following this format - it breaks the project's automated changelog and release process.**
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -230,3 +230,81 @@ The framework extends Koa's context with Egg-specific features:
 - Update versions in one place to keep consistency across packages
 - Use `pnpm update --latest` to update catalog entries
 - Reference catalog entries in individual packages with `"package-name": "catalog:"`
+
+## Commit Message Format
+
+**IMPORTANT: All commits MUST follow the [Angular Commit Message Format](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) as specified in CONTRIBUTING.md.**
+
+### Format Structure
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+### Required Types
+
+- **feat**: A new feature
+- **fix**: A bug fix
+- **docs**: Documentation-only changes
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **perf**: A code change that improves performance
+- **test**: Adding missing tests
+- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
+- **deps**: Updates about dependencies
+
+### Scope Guidelines
+
+- Use package names for package-specific changes: `core`, `mock`, `cluster`, `utils`, etc.
+- Use feature areas for cross-package changes: `loader`, `plugin`, `config`, etc.
+- Use component names for specific functionality: `application`, `agent`, `context`, etc.
+
+### Subject Guidelines
+
+- Use succinct words to describe what you did in the commit change
+- Use imperative, present tense: "change" not "changed" nor "changes"
+- Don't capitalize first letter
+- No period (.) at the end
+
+### Body Guidelines (Optional)
+
+- Add more content if the subject is not self-explanatory enough
+- Explain the purpose or reason for the commit
+- Include motivation for the change and contrasts with previous behavior
+
+### Footer Guidelines
+
+- **Breaking Changes**: Note clearly with "BREAKING CHANGE:" prefix
+- **Related Issues**: Use format like "Closes #1, Closes #2, #3"
+- **Cross-references**: Reference related repos like "eggjs/egg-core#123"
+
+### Examples
+
+```
+feat(core): add support for async configuration loading
+
+Allow configuration files to export async functions for dynamic config loading.
+This enables loading configuration from external services or databases.
+
+Closes #123
+```
+
+```
+fix(mock): resolve memory leak in test cleanup
+
+The mock cleanup process was not properly disposing of event listeners,
+causing memory leaks during test runs.
+
+Fixes #456
+```
+
+```
+docs(tsconfig): update README with vitest integration examples
+
+Add examples showing how to configure vitest with the tsconfig package.
+Include setup instructions and common configuration patterns.
+```
