Skip to content

Document changelog format - #76

Merged
nertzy merged 1 commit into
masterfrom
document-changelog-format
Oct 12, 2026
Merged

nertzy merged 1 commit into
masterfrom
document-changelog-format

Conversation

@nertzy

@nertzy nertzy commented Oct 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

Document the conventions CHANGELOG.md already follows, in a new "Changelog format" subsection of CONTRIBUTING.md:

  • ### X.Y.Z headings, newest first, with ### Unreleased at the top
  • One bullet per change, written from the gem user's point of view
  • Imperative verb, full sentence ending in a period, code in backticks, lines wrapped at 80 columns
  • Dependency changes last: Active Record before Ruby, added support before a raised minimum
  • No issue or pull request numbers
  • Contributors from outside the maintainers credited by name in parentheses

Test plan

  • Docs-only change; compared each rule against the 2.2.0 through 2.4.0 entries

Copilot AI balanced review requested due to automatic review settings October 12, 2026 20:42

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation is clear, internally consistent, and matches recent changelog practices.

0 open findings

What changed in this PR

Documents the project’s established changelog conventions for contributors.

Changes:

  • Clarifies when changelog entries are required.
  • Defines formatting, ordering, wording, and attribution rules.
File Description
CONTRIBUTING.md Adds changelog authoring and release-entry guidelines.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@nertzy
nertzy force-pushed the document-changelog-format branch from 1446598 to 1a36345 Compare October 12, 2026 23:08
@nertzy
nertzy merged commit 9a45201 into master Oct 12, 2026
10 checks passed
@nertzy
nertzy deleted the document-changelog-format branch October 12, 2026 23:09
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.

2 participants