verifying-changelog-in-framework
Original:🇨🇳 Chinese
Translated
This is a skill to check whether the content of CHANGELOG.md in a framework intended for external release is appropriate. It is used when updating or reviewing CHANGELOG.md.
1installs
Sourceseika139/dotfiles
Added on
NPX Install
npx skill4agent add seika139/dotfiles verifying-changelog-in-frameworkTags
Translated version includes tags in frontmatterSKILL.md Content (Chinese)
View Translation Comparison →Rules for Verifying CHANGELOG.md in Framework
- Always update CHANGELOG.md when there are changes to the package from the perspective of framework users
- Basically, updates are required when there are changes to non-private classes or methods under src/
- Note that if the implementation involves a breaking change, you must address it by updating the minor or major version in accordance with SemVer
- However, changes made to fix internal bugs (bug fixes) that are breaking changes with low impact are allowed to be addressed with a patch version update
Important Formatting and Content Rules
When updating CHANGELOG.md for changes, follow the format below.
- The format is based on Keep a Changelog
- The CHANGELOG should only describe changes visible from the user's perspective
- Instead of writing implementation details, briefly describe what features were added, changed, or fixed from the viewpoint of the service user
- Describe changes to the external parts that serve as the interface of this framework from the user's perspective
- Focus on the impact on users when they use the framework, rather than the changes within the framework itself
- PR and Issue numbers should be written in link format like
[#123](github.com/your-repo/issues/123) - Use systems, code, or classes as the subject
- Briefly describe changes and additions
- For bug fixes, describe the phenomenon or problem that occurred
- If there are alternative methods, include them
- Write class names using their FQCN even if it is somewhat verbose