Skip to content

docs: seed CHANGELOG.md (Keep-a-Changelog format) - #63

Merged
hyperpolymath merged 2 commits into
mainfrom
claude/changelog-seed-2026-05-26
Jul 29, 2026
Merged

hyperpolymath merged 2 commits into
mainfrom
claude/changelog-seed-2026-05-26

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Closes Row-2 Phase 3 of the 2026-05-26 estate tech-debt audit chain for this repo. The 2026-05-26 documentation-debt audit (hyperpolymath/standards#197) flagged that 180 of 279 estate repos lacked a CHANGELOG.md (65% gap) — this seed closes that finding here.

The seed:

  • Uses Keep-a-Changelog format with an [Unreleased] section.
  • Buckets the most recent 100 commits by conventional-commit prefix (feat/fix/refactor/docs/ci/build) into Added/Fixed/Changed/ Documentation/CI sections.
  • References standards#206's changelog-reusable.yml + the canonical templates/cliff.toml for full-regeneration via git-cliff.

The file is initial — the maintainer can adopt changelog-reusable.yml in this repo's CI to keep it auto-regenerated, or regenerate manually.

Summary

Closes #

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (would change existing behaviour)
  • 🕳️ Soundness fix (fixes a checker/proof false-negative)
  • 📖 Documentation
  • 🧹 Refactor / tech debt (behaviour-preserving)
  • ⚡ Performance
  • 🔧 Build / CI / tooling

How has this been verified?

Checklist

  • My commits are signed (git commit -S).
  • I ran the project's own checks/tests locally and they pass.
  • New files carry the correct SPDX-License-Identifier (code/config MPL-2.0,
    prose CC-BY-SA-4.0); I did not relicense existing files.
  • Docs are updated, and no public claim now overstates what the code does.
  • I have not introduced a soundness hole (or I have flagged where I might have).

Notes for reviewers

Closes Row-2 Phase 3 of the 2026-05-26 estate tech-debt audit chain
for this repo. The 2026-05-26 documentation-debt audit
(hyperpolymath/standards#197) flagged that 180 of 279 estate repos
lacked a CHANGELOG.md (65% gap) — this seed closes that finding here.

The seed:
  - Uses Keep-a-Changelog format with an [Unreleased] section.
  - Buckets the most recent 100 commits by conventional-commit prefix
    (feat/fix/refactor/docs/ci/build) into Added/Fixed/Changed/
    Documentation/CI sections.
  - References standards#206's changelog-reusable.yml + the canonical
    templates/cliff.toml for full-regeneration via git-cliff.

The file is initial — the maintainer can adopt changelog-reusable.yml
in this repo's CI to keep it auto-regenerated, or regenerate manually.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@gitar-bot

gitar-bot Bot commented Jul 29, 2026 •

Copy link
Copy Markdown

Note

Automatic reviews are paused because your trial's included automatic processing has been used for this period. Upgrade now, or comment "Gitar review" to run a review anytime.
Learn more

Code Review ✅ Approved 2 resolved / 2 findings

Seeds the initial CHANGELOG.md using the Keep-a-Changelog format to address documentation debt. Consider updating the license header to CC-BY-SA-4.0 for prose and adding the missing [Unreleased] link-reference definition.

Auto-approved and auto-merge armed: No blocking issues found.
Please see Auto-approve Docs for details on setting custom approval criteria. — merges when pipeline and required approvals pass.

✅ 2 resolved
✅ Quality: CHANGELOG uses MPL-2.0 but PR convention says prose is CC-BY-SA-4.0

📄 CHANGELOG.md:1-3
This PR's own checklist states new files must carry the correct SPDX identifier: code/config MPL-2.0, prose CC-BY-SA-4.0. A CHANGELOG is prose/documentation (the PR is tagged docs), yet line 2 declares SPDX-License-Identifier: MPL-2.0. This contradicts the stated estate convention; change the header to SPDX-License-Identifier: CC-BY-SA-4.0 to match the prose-licensing rule.

✅ Quality: [Unreleased] heading lacks a link-reference definition

📄 CHANGELOG.md:19
Keep a Changelog renders ## [Unreleased] as a hyperlink only when a matching link-reference definition (e.g. [Unreleased]: https://.../compare/...) is present at the bottom of the file. No such definition exists, so the brackets render as literal text. Either add the reference definition or drop the brackets to avoid a broken-looking link.

Options

Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Compact
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

Comment thread CHANGELOG.md
Comment thread CHANGELOG.md
@gitar-bot

gitar-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown

⚠️ Gitar auto-approved this PR but could not enable auto-merge: auto-merge is disabled for this repository — enable "Allow auto-merge" in the repository settings.

gitar-bot[bot]
gitar-bot Bot previously approved these changes Jul 29, 2026

@gitar-bot gitar-bot Bot 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.

Gitar has auto-approved this PR and enabled auto-merge (configure)

@gitar-bot gitar-bot Bot added the gitar-approved Added by Gitar label Jul 29, 2026
Signed-off-by: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com>
@hyperpolymath
hyperpolymath merged commit fbd0d90 into main Jul 29, 2026
17 checks passed
@hyperpolymath
hyperpolymath deleted the claude/changelog-seed-2026-05-26 branch July 29, 2026 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gitar-approved Added by Gitar

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant