Skip to content

Conform CHANGELOG.md entries to the house style - #12

Merged
billfreeman44 merged 2 commits into
masterfrom
changelog-house-style
Sep 6, 2026
Merged

billfreeman44 merged 2 commits into
masterfrom
changelog-house-style

Conversation

@billfreeman44

Copy link
Copy Markdown
Member

What

Rewrites every nonconforming CHANGELOG.md bullet in the house style: one bullet per change, a fragment or one short sentence with a full stop, named the way the pre-2026 entries name things.

Part of the fleet-wide conformance pass. The style itself is codified in the igl-* CLAUDE.md PRs (igl-gotv #49); recent entries had drifted into multi-paragraph essays with measured figures and design rationale.

Invariants

  • Only CHANGELOG.md changes; the ## version-heading sequence is byte-identical, and no entry moved between versions or sections.
  • Every change keeps its own bullet — condensed, never deleted. Requires ... deploy-order notes survive as the permitted second sentence; breaking markers are normalized to (**Breaking**).
  • The dropped detail (measurements, rationale, before/after narrative) remains in the original PR descriptions and in git history.

🤖 Generated with Claude Code

Format-only pass: rewrite nonconforming bullets to one-line house-style
form. No changes added, removed, moved, or re-versioned.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

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.

🟡 Changes recommended

The updated bullets are overly generic and appear to merge multiple distinct changes into single entries, undermining the stated “one bullet per change” goal and losing important specifics.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR refactors the latest CHANGELOG.md entries to match the repository’s changelog “house style” by shortening nonconforming bullets.

Changes:

  • Condenses the “deploy workflows” changelog entry into a shorter bullet.
  • Condenses the “GitHub Actions Node 24 runtimes” changelog entry into a shorter bullet.
File summaries
File Description
CHANGELOG.md Rewrites two “Changed” bullets under 6.0.4 to be shorter and more style-conformant.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Lite

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

Comment thread CHANGELOG.md Outdated
Restore lost operational notes (fail-open captcha, DLQ watch, staging
deploy target, stage qualifier, deferred non-pro matches), fix an
ambiguous LSI bullet and two grammar issues, tighten blank lines
between bullets, and say Node.js 24 for the Actions runtimes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

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

Only changelog formatting/wording is touched and it adheres to the stated invariants, with at most a minor wording tweak suggested.

Review details

Suppressed comments (1)

CHANGELOG.md:13

  • Wording is slightly ambiguous/ungainly (“update … to runtimes”); adding “use” makes the sentence read cleanly while keeping the one-liner house style.
- Update GitHub Actions to Node.js 24 runtimes.
  • Files reviewed: 1/1 changed files
  • Comments generated: 0 new
  • Review effort level: Lite

@billfreeman44
billfreeman44 merged commit eb655ef into master Sep 6, 2026
7 checks passed
@billfreeman44
billfreeman44 deleted the changelog-house-style branch September 6, 2026 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants