Skip to content

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

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

billfreeman44 merged 3 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

A couple of rewritten bullets become ambiguous or lose key meaning compared to the original entries, reducing the changelog’s clarity.

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

Pull request overview

Reformats CHANGELOG.md entries to match the project’s house style by condensing verbose bullets into shorter, consistent, sentence-style entries while keeping the existing version/section structure intact.

Changes:

  • Condense the Unreleased “Changed” section into short bullets and sub-bullets.
  • Shorten and normalize a few 0.8.2 / 0.8.1 “Changed” bullets to match the standard style.
File summaries
File Description
CHANGELOG.md Condenses and normalizes changelog bullets to the house style without restructuring versions/sections.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 2
  • 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
- Update the dataset page and the Data Science FAQ.
- Move the 2022 FAQ, the 2024 CS2 pages, and the CS:GO pages under `datascience/old/`.
- Harden the deploy workflows.
- Update GitHub Actions to Node 24 runtimes.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Addressed by the fleet-wide rename to "Update GitHub Actions to Node.js 24 runtimes." - the line names the Actions runtimes, not the toolchain Node version.

Comment thread CHANGELOG.md Resolved
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.

🔵 Needs a closer look

There’s a small remaining style inconsistency (gh-pages not formatted as a literal identifier) in an otherwise style-focused changelog conformance PR.

Review details

Suppressed comments (1)

Previously missed (1) — in code that hasn't changed since the last review.

CHANGELOG.md:34

  • To match the surrounding convention of marking code/identifier-like names in backticks (e.g., npm publish), gh-pages should be formatted as a literal identifier here as well.
  • Files reviewed: 1/1 changed files
  • Comments generated: 0 new
  • Review effort level: Lite

Say one poll per 5 s instead of 1/5s, name the environment=staging
input on the release.yml deploy note, and backtick the gh-pages job.

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

Copy link
Copy Markdown
Member Author

On the suppressed gh-pages note: fixed in the follow-up commit - gh-pages is now backticked.

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 changes are limited to changelog wording/formatting and appear to preserve the existing structure and meaning without introducing inconsistencies.

Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0 new
  • Review effort level: Lite

@billfreeman44
billfreeman44 merged commit 17b05fa into master Sep 6, 2026
6 checks passed
@billfreeman44
billfreeman44 deleted the changelog-house-style branch September 6, 2026 17:40
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