Skip to content

Commit 07399f3

Browse files
committed
docs: clarify issue links in release summaries
closes #778 Signed-off-by: Rui Chen <rui@chenrui.dev>
1 parent 93e4a00 commit 07399f3

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

RELEASE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Use this checklist when cutting a new `action-gh-release` release.
1313
1. Update [package.json](package.json) to the new version.
1414
2. Add the new entry at the top of [CHANGELOG.md](CHANGELOG.md).
1515
- Summarize the release in 1 short paragraph.
16+
- If the summary mentions issues, use plain `#123` references or full issue links; do not wrap issue numbers like `#123` in backticks.
1617
- Prefer user-facing fixes and features over internal churn.
1718
- Keep the merged PR list aligned with `.github/release.yml` categories.
1819
3. Run `npm i` to refresh [package-lock.json](package-lock.json).

0 commit comments

Comments
 (0)