Skip to content

Add CHANGELOG.md#25

Merged
kodroi merged 1 commit intomainfrom
docs/add-changelog
Feb 20, 2026
Merged

Add CHANGELOG.md#25
kodroi merged 1 commit intomainfrom
docs/add-changelog

Conversation

@kodroi
Copy link
Copy Markdown
Owner

@kodroi kodroi commented Feb 19, 2026

Summary

  • Added CHANGELOG.md documenting all releases from v1.0.2 (initial release) through v1.2.0 (OpenCode support).
  • Added v1.2.1 entry for the changelog addition itself.
  • Updated CLAUDE.md with changelog maintenance instructions so future changes follow a consistent process.

Test plan

  • Verify CHANGELOG.md renders correctly on GitHub
  • Verify CLAUDE.md changelog section is appended correctly
  • Confirm no unrelated changes are included in the diff

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive changelog documenting all releases from v1.0.2 through v1.2.1 with notable changes per version.
    • Updated project documentation with changelog maintenance guidelines for future releases.

Add comprehensive CHANGELOG.md documenting all releases from v1.0.2
through v1.2.0, plus a v1.2.1 entry for the changelog addition itself.
Append changelog maintenance instructions to CLAUDE.md.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 19, 2026

📝 Walkthrough

Walkthrough

The PR adds project documentation: a new CHANGELOG.md file documenting all historical releases from v1.0.2 through v1.2.1, and updates CLAUDE.md with changelog maintenance instructions for contributors. No functional code changes.

Changes

Cohort / File(s) Summary
Documentation
CHANGELOG.md, CLAUDE.md
Added comprehensive changelog documenting releases v1.0.2–v1.2.1 and updated contributor guidance with changelog maintenance instructions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hop hop, we chronicle with care,
Versions past and present declare,
CHANGELOG blooms, CLAUDE lights the way,
History preserved for every day!
With whiskers twitched and ears held high,
Documentation done—let standards fly! 📋✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'Add CHANGELOG.md' directly and clearly describes the main change—adding a changelog file. It is concise, specific, and accurately reflects the primary objective of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/add-changelog

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CHANGELOG.md`:
- Around line 23-25: Update the forward reference in the CHANGELOG entry for
v1.1.12: replace "Same issue as v1.1.13" with wording that points backwards
(e.g., remove the forward reference or change it so v1.1.13's entry references
v1.1.12). Specifically edit the v1.1.12 paragraph that mentions `run-hook.cmd`
and the version strings "v1.1.12" / "v1.1.13" so the cross-reference correctly
indicates that v1.1.13 repeated the issue originally introduced in v1.1.12.

In `@CLAUDE.md`:
- Around line 58-60: Add a top-level "## Unreleased" heading to CHANGELOG.md as
a placeholder so contributors have an example section to add entries; insert the
"## Unreleased" header at the very top (above existing entries) and include one
example bullet showing the expected format (brief description + PR reference) or
a short note telling contributors to add entries there, following the existing
changelog style.

Comment thread CHANGELOG.md
Comment on lines +23 to +25
## v1.1.12 (2026-02-11)

- **Fix**: Added execute permissions to `run-hook.cmd`. Same issue as v1.1.13 - the polyglot script needs the executable bit set on Unix/POSIX systems (Linux, macOS). Windows is unaffected as it doesn't use Unix permission bits.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Forward reference in v1.1.12 entry reads backwards.

Line 25 says "Same issue as v1.1.13", but v1.1.12 predates v1.1.13 — the issue occurred first in v1.1.12 and recurred in v1.1.13. The cross-reference direction should be reversed: v1.1.13's entry should say "Same issue as v1.1.12", not the other way around.

📝 Suggested rewording
 ## v1.1.13 (2026-02-11)
 
-- **Fix**: Restored execute permissions on `run-hook.cmd` that were lost during a prior commit. Without execute permissions, the hook silently failed on Linux and macOS (Unix/POSIX systems) where file permission bits are enforced.
+- **Fix**: Restored execute permissions on `run-hook.cmd` that were lost during a prior commit (same issue as v1.1.12). Without execute permissions, the hook silently failed on Linux and macOS (Unix/POSIX systems) where file permission bits are enforced.
 
 ## v1.1.12 (2026-02-11)
 
-- **Fix**: Added execute permissions to `run-hook.cmd`. Same issue as v1.1.13 - the polyglot script needs the executable bit set on Unix/POSIX systems (Linux, macOS). Windows is unaffected as it doesn't use Unix permission bits.
+- **Fix**: Added execute permissions to `run-hook.cmd`. The polyglot script needs the executable bit set on Unix/POSIX systems (Linux, macOS). Windows is unaffected as it doesn't use Unix permission bits.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` around lines 23 - 25, Update the forward reference in the
CHANGELOG entry for v1.1.12: replace "Same issue as v1.1.13" with wording that
points backwards (e.g., remove the forward reference or change it so v1.1.13's
entry references v1.1.12). Specifically edit the v1.1.12 paragraph that mentions
`run-hook.cmd` and the version strings "v1.1.12" / "v1.1.13" so the
cross-reference correctly indicates that v1.1.13 repeated the issue originally
introduced in v1.1.12.

Comment thread CLAUDE.md
Comment on lines +58 to +60
## Changelog

When making user-facing changes, update `CHANGELOG.md` in the project root. Add entries under an `## Unreleased` section at the top, following the existing format: brief description of what changed and why it matters to users, with PR references where applicable.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

## Unreleased section is missing from CHANGELOG.md.

The guidance here tells contributors to add entries under ## Unreleased, but CHANGELOG.md itself has no such section and no example of it. A contributor following this instruction would need to know to create the section from scratch. Consider adding an empty ## Unreleased placeholder at the top of CHANGELOG.md so the format is self-evident.

📝 Suggested addition to CHANGELOG.md
 # Changelog
 
 All notable changes to this project are documented in this file.
 
+## Unreleased
+
 ## v1.2.1 (2026-02-19)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` around lines 58 - 60, Add a top-level "## Unreleased" heading to
CHANGELOG.md as a placeholder so contributors have an example section to add
entries; insert the "## Unreleased" header at the very top (above existing
entries) and include one example bullet showing the expected format (brief
description + PR reference) or a short note telling contributors to add entries
there, following the existing changelog style.

@kodroi kodroi merged commit 428c4da into main Feb 20, 2026
13 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.

1 participant