| name | release-docs |
| description | Generate or update release documentation โ README.md styling with badges and navigation, CHANGELOG entries, and release notes for version management |
| allowed-tools | ["Read","Write","Edit","Glob","Grep","Agent","Bash(ls:*)","Bash(git:*)","Bash(git log:*)","Bash(git tag:*)","Bash(git diff:*)"] |
| arguments | ["target"] |
| argument-hint | [readme, changelog, release-notes, or all] |
| user-invocable | true |
| when_to_use | Use when the user wants to update release documentation, restyle a README, generate changelog entries, or create release notes.
Examples: 'README redesign', 'modernize README', 'add badges', 'changelog update', 'release notes',
'README ์คํ์ผ๋ง', 'README ๊พธ๋ฉฐ์ค', 'CHANGELOG ์
๋ฐ์ดํธ', '๋ฆด๋ฆฌ์ฆ ๋
ธํธ', '๋ฌธ์ ์ ๋ฆฌ', 'README ๋ค์ ๋ง๋ค์ด์ค'
|
Release Docs
Overview
์ธ ๊ฐ์ง ๋ฌธ์ ์์ฑ ๊ธฐ๋ฅ์ ์ ๊ณตํ๋ค:
- README โ ์ต์ GitHub ์คํ์ผ๋ก README.md ๋ฆฌ๋์์ธ
- CHANGELOG โ git log ๊ธฐ๋ฐ CHANGELOG.md ์์ฑ/์
๋ฐ์ดํธ
- Release Notes โ ๋ฒ์ ๊ฐ ๋ณ๊ฒฝ ์์ฝ
Inputs
$target: readme, changelog, release-notes, ๋๋ all
README Mode
Process
- ํ๋ก์ ํธ ๋ถ์: ๊ธฐ์กด README, ๋ฃจํธ ์ค์ ํ์ผ(
package.json, pyproject.toml ๋ฑ), ๋ผ์ด์ ์ค, ๋๋ ํ ๋ฆฌ ๊ตฌ์กฐ๋ฅผ ํ์
ํ๋ค.
- ๊ธฐ์ ์คํ ์๋ณ: ์ฌ์ฉ ์ธ์ด, ํ๋ ์์ํฌ, ๋น๋/ํ
์คํธ ๋๊ตฌ๋ฅผ ํ์
ํ๋ค.
- ์น์
์ค๊ณ: ํ๋ก์ ํธ์ ํด๋นํ๋ ์น์
๋ง ์ ํํ๋ค.
- README ์์ฑ:
references/readme-style-guide.md ์คํ์ผ ๊ฐ์ด๋๋ฅผ ๋ฐ๋ฅธ๋ค.
- ๊ฒ์ฆ: ๋ชจ๋ ํ์ผ ๊ฒฝ๋ก, ๋ช
๋ น์ด, ๊ธฐ๋ฅ ์ค๋ช
์ด ์ค์ ํ๋ก์ ํธ์ ์ผ์นํ๋์ง ํ์ธํ๋ค.
README Rules
- ํ๋ก์ ํธ์ ์ค์ ์กด์ฌํ๋ ๊ธฐ์ ๋ง ๋ฐฐ์ง์ ํฌํจ
- ์กด์ฌํ์ง ์๋ CI, npm, PyPI ๋ฐฐ์ง๋ฅผ ๋ง๋ค์ง ์์
- ๊ธฐ์กด README์ ํต์ฌ ์ ๋ณด๋ฅผ ๋๋ฝํ์ง ์์
- ํ๋ก์ ํธ ๊ท๋ชจ์ ๋น๋กํ ๋ถ๋ (์๊ท๋ชจ ~80์ค, ์ค๊ท๋ชจ ~150์ค, ๋๊ท๋ชจ 200์ค+)
- ๊ธฐ์กด README์ ์ธ์ด(ํ๊ตญ์ด/์์ด/ํผํฉ)๋ฅผ ๋ฐ๋ฆ
CHANGELOG Mode
Process
- ๋ง์ง๋ง ํ๊ทธ/๋ฆด๋ฆฌ์ค ์ดํ์ git log๋ฅผ ์์งํ๋ค.
- ์ปค๋ฐ์ ๋ถ๋ฅํ๋ค: Added, Changed, Fixed, Removed, Security, Deprecated.
references/changelog-template.md์ Keep a Changelog ํ์์ผ๋ก ์์ฑํ๋ค.
- ๊ธฐ์กด CHANGELOG.md๊ฐ ์์ผ๋ฉด ์๋จ์ ์ ํญ๋ชฉ์ ์ถ๊ฐํ๋ค.
Commit Classification
| ์ปค๋ฐ prefix | CHANGELOG ์นดํ
๊ณ ๋ฆฌ |
|---|
feat:, add: | Added |
change:, update:, refactor: | Changed |
fix:, bugfix: | Fixed |
remove:, delete: | Removed |
security: | Security |
deprecate: | Deprecated |
| prefix ์์ | ๋ด์ฉ์ผ๋ก ํ๋จ |
Release Notes Mode
Process
- ๋ ํ๊ทธ/์ปค๋ฐ ๊ฐ์ diff๋ฅผ ์์งํ๋ค.
- ๋ณ๊ฒฝ์ฌํญ์ ์์ฝํ๋ค:
- Breaking changes (์ต์๋จ)
- New features
- Bug fixes
- Other changes
- GitHub release body ํ์์ผ๋ก ์ถ๋ ฅํ๋ค.
Quality Rules
- ๊ธฐ์ ์ฉ์ด(๋ช
๋ น์ด, ํ์ผ ๊ฒฝ๋ก, ํจ์๋ช
)๋ ํญ์ ์์ด
- ํ๋ก์ ํธ์ ์๋ ๊ธฐ๋ฅ์ ์ธ๊ธํ์ง ์์
- ๊ธฐ์กด ๋ฌธ์์ ํต์ฌ ์ ๋ณด๋ฅผ ๋ณด์กด
- CHANGELOG๋ Keep a Changelog ํ์์ ์ค์
- Release notes๋ ์ฌ์ฉ์ ๊ด์ ์ผ๋ก ์์ฑ (๋ด๋ถ ๊ตฌํ ๋ํ
์ผ ์ต์ํ)