From 07399f331709e4e13ea561e9e534e3b0dc3fb687 Mon Sep 17 00:00:00 2001 From: Rui Chen Date: Sun, 12 Apr 2026 08:13:03 -0400 Subject: [PATCH] docs: clarify issue links in release summaries closes #778 Signed-off-by: Rui Chen --- RELEASE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/RELEASE.md b/RELEASE.md index cd9538f..f96b447 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -13,6 +13,7 @@ Use this checklist when cutting a new `action-gh-release` release. 1. Update [package.json](package.json) to the new version. 2. Add the new entry at the top of [CHANGELOG.md](CHANGELOG.md). - Summarize the release in 1 short paragraph. + - If the summary mentions issues, use plain `#123` references or full issue links; do not wrap issue numbers like `#123` in backticks. - Prefer user-facing fixes and features over internal churn. - Keep the merged PR list aligned with `.github/release.yml` categories. 3. Run `npm i` to refresh [package-lock.json](package-lock.json).