You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
36 lines
901 B
36 lines
901 B
---
|
|
description: Write release changelogs from real repository changes
|
|
alwaysApply: true
|
|
---
|
|
|
|
# Changelog Writing
|
|
|
|
When the user asks for a version update, release note, changelog, or says "写版本更新":
|
|
|
|
- First inspect the real repository changes with `git status`, `git diff --stat`, and relevant `git diff` details.
|
|
- Base the changelog only on observed code, asset, locale, route, API, and UI changes.
|
|
- Do not invent product behavior. If a change is unclear, describe it cautiously or leave it out.
|
|
- Group the output into `功能新增`, `优化`, and `修复`.
|
|
- Use Chinese by default, unless the user asks for another language.
|
|
- Write for users and product release notes, not as a technical commit log.
|
|
- Keep the format close to:
|
|
|
|
```md
|
|
## Changelog
|
|
|
|
### vX.X.X -- YYYY-MM-DD
|
|
|
|
### Popi.art Web
|
|
|
|
**版本**
|
|
vX.X.X
|
|
|
|
**功能新增**
|
|
- ...
|
|
|
|
**优化**
|
|
- ...
|
|
|
|
**修复**
|
|
- ...
|
|
```
|
|
|