Documentation
README
Release Notes
Generate user-facing release notes for the current project since the last release.
Procedure
- Determine the last release point (git tags) and collect the change set since then (git log / diff of user-facing surfaces).
- Classify changes:
- 新功能 (new features)
- 改进 (improvements / behavior changes)
- 修复 (bug fixes)
- 破坏性变更 (breaking changes — call these out first)
- 内部 (chore/refactor — omit from user-facing notes or fold into a footnote)
- Write notes in the user's language, focused on what changed for users — not implementation details.
- Reference issues/PRs where known, keep each bullet one line, group under the sections above.
Constraints
This is the opening of the README. Read the full README on GitHub.