Skip to content

docs: Remove PR/issue references from release notes template#2743

Merged
tusharmath merged 1 commit intomainfrom
skill-feedback
Mar 30, 2026
Merged

docs: Remove PR/issue references from release notes template#2743
tusharmath merged 1 commit intomainfrom
skill-feedback

Conversation

@tusharmath
Copy link
Copy Markdown
Collaborator

Summary

Remove PR/issue references from the release notes skill template to create cleaner, more user-focused release notes.

Context

Release notes are meant to communicate value to end users, not serve as a changelog for developers. Including PR numbers and GitHub links (#123, [PR link]) adds noise and shifts focus from the user experience to development tracking.

This update aligns the release notes skill with best practices for user-facing documentation by removing all PR/issue reference patterns from the template and adding explicit guidance against including them.

Changes

  • Removed ([#NNN](url)) pattern from highlights section template
  • Updated bug fixes section guidance to remove "PR link" reference
  • Added explicit guideline: "No PR/issue references - do not include PR numbers, issue numbers, or links to GitHub PRs/issues in the release notes"

Use Cases

When using the write-release-notes skill, the generated release notes will now:

  • Focus purely on user value and impact
  • Avoid GitHub-specific tracking identifiers
  • Be cleaner and more readable for end users
  • Match industry best practices for public-facing release notes

Testing

# Verify the skill template has been updated
cat .forge/skills/write-release-notes/SKILL.md | grep -A 5 "No PR/issue"

# Test the skill by generating release notes
forge skill write-release-notes
# Verify generated notes do not contain PR/issue references

Links

  • Related skill: .forge/skills/write-release-notes/SKILL.md

@tusharmath tusharmath merged commit 41278af into main Mar 30, 2026
25 checks passed
@tusharmath tusharmath deleted the skill-feedback branch March 30, 2026 14:06
@tusharmath tusharmath added the type: chore Routine tasks like conversions, reorganization, and maintenance work. label Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: chore Routine tasks like conversions, reorganization, and maintenance work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant