Fix/v0.5.0 beta fixes

[VariableThe]

Summary by CodeRabbit

• Documentation
  • Added a complete, Keep a Changelog + SemVer formatted CHANGELOG.md with categorized, user-facing release notes across multiple versions.
  • Expanded documentation requirements to require AUDIT_LOG.md entries for significant changes, and CHANGELOG.md entries for user-facing updates (Added/Changed/Fixed/Performance/Security).
  • Updated contributor and scope guidance to reflect the new changelog/audit logging expectations.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3bc314ed-5c03-42a6-a833-ec56d4929eb8

📥 Commits

Reviewing files that changed from the base of the PR and between 409ffa3 and bcfc64c.

📒 Files selected for processing (1)

• CHANGELOG.md

✅ Files skipped from review due to trivial changes (1)

• CHANGELOG.md

---

📝 Walkthrough

Walkthrough

Introduces CHANGELOG.md with structured release notes for PaperCache versions v0.1.0 through v0.5.0-beta. Updates the audit logging rules in both AGENTS.md and CONTRIBUTING.md to require user-facing changes to also be recorded in CHANGELOG.md under the appropriate release section.

Changes

Changelog Introduction

Layer / File(s)	Summary
CHANGELOG.md creation and guideline updates CHANGELOG.md, .agents/AGENTS.md, CONTRIBUTING.md	Adds the full CHANGELOG.md with categorized release notes (Added, Changed, Fixed, Performance, Security) from v0.1.0 to v0.5.0-beta. Both AGENTS.md and CONTRIBUTING.md are updated so the audit logging rule now mandates CHANGELOG.md entries for user-facing changes in addition to AUDIT_LOG.md entries.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 A changelog was born, with versions galore,
From v0.1 to beta and more!
I hopped through the fixes, the features, the lore,
And scribbled it all on the docs forest floor.
Now AGENTS and CONTRIBUTING both know the score! 🌿

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Fix/v0.5.0 beta fixes' is vague and generic, using non-descriptive language that doesn't convey the specific nature of the changes made in this PR.	Replace with a more specific title that describes the actual changes, such as 'Update documentation requirements for CHANGELOG and AUDIT_LOG' or similar to reflect the documentation updates made.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/v0.5.0-beta-fixes

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CHANGELOG.md`:
- Around line 35-68: The CHANGELOG.md file has a gap in version ordering where
v0.4.0 is followed directly by v0.2.0, skipping v0.3.0 entirely. This breaks
semantic versioning conventions. Either add a new section for v0.3.0 with its
corresponding release date and changes between v0.2.0 and v0.4.0, or insert an
explicit comment (e.g., a note stating "v0.3.0 was skipped" or similar
explanation) in the changelog to document why this version was omitted from the
release history.

🪄 Autofix (Beta)

✅ Autofix completed

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: afbef0a6-aad9-4e77-9f4d-51536395dbd5

📥 Commits

Reviewing files that changed from the base of the PR and between 205e35f and 409ffa3.

📒 Files selected for processing (3)

• .agents/AGENTS.md
• CHANGELOG.md
• CONTRIBUTING.md

[coderabbitai]

Note

Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it.

Fixes Applied Successfully

Fixed 1 file(s) based on 1 unresolved review comment.

Files modified:

• CHANGELOG.md

Commit: bcfc64c293a8dd4af1777901bd4f56ec46641d71

The changes have been pushed to the fix/v0.5.0-beta-fixes branch.

Time taken: 1m 47s