Skip to content

docs: add release notes process to CHANGELOG guidelines#435

Merged
PrincessnJoy merged 1 commit into
PrincessnJoy:mainfrom
Julianemeka:docs/changelog-release-notes-process-339
Jun 27, 2026
Merged

docs: add release notes process to CHANGELOG guidelines#435
PrincessnJoy merged 1 commit into
PrincessnJoy:mainfrom
Julianemeka:docs/changelog-release-notes-process-339

Conversation

@Julianemeka

Copy link
Copy Markdown
Contributor

Summary

Expands CHANGELOG.md with a comprehensive contributor guide for writing release notes consistently.

Changes

  • When to add an entry — every user-visible PR requires one
  • Entry format — template with all sub-headings
  • Category definitions — Added / Changed / Fixed / Breaking Changes / Security / Removed
  • Commit → changelog mapping table (feat → Added, fix → Fixed, etc.)
  • Example entries — concrete before/after samples
  • Release procedure — rename Unreleased, tag, add comparison link

Closes #339

Closes PrincessnJoy#339

- Document when and how to write changelog entries
- Define category mapping (Added/Changed/Fixed/Breaking/Security/Removed)
- Align commit type to changelog category table
- Provide concrete example entries
- Describe version-cut procedure (rename, tag, comparison link)
@drips-wave

drips-wave Bot commented Jun 26, 2026

Copy link
Copy Markdown

@Julianemeka Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@PrincessnJoy PrincessnJoy merged commit a8e540f into PrincessnJoy:main Jun 27, 2026
5 of 11 checks passed
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.

Add release notes process to CHANGELOG guidelines

2 participants