Skip to content

docs(releases): use plain-language release titles and notes - #101

Merged
Go2Engle merged 1 commit into
mainfrom
feature/plain-language-releases
Oct 10, 2026
Merged

Go2Engle merged 1 commit into
mainfrom
feature/plain-language-releases

Conversation

@Go2Engle

Copy link
Copy Markdown
Owner

Summary

Record the preference for release titles and notes that people without a development background can understand. Future changes should describe the user benefit before implementation details.

Type of Change

Documentation

Technical Details

  • Add persistent release-writing guidance to AGENTS.md.
  • Keep Conventional Commit prefixes while using plain-language subjects suitable for generated release notes.
  • Include an example contrasting the updater's technical wording with its user benefit.

Testing Performed

Reviewed the guidance and ran git diff --check. No application behavior changes.

Breaking Changes

None.

@Go2Engle
Go2Engle merged commit 067c67a into main Oct 10, 2026
5 checks passed
@Go2Engle
Go2Engle deleted the feature/plain-language-releases branch October 10, 2026 00:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant