Summary
CHANGELOG.md is sparse compared with the dozens of PR description files at the root, and there is no guidance in .github/copilot-instructions.md or README on updating it.
Why this matters
Consumers of the API and operators cannot see what changed between deployments, especially for breaking changes caught by the Optic check.
Scope
Adopt Keep a Changelog format, backfill notable entries from existing PR_DESCRIPTION files before they are removed, and document the update rule for contributors.
Relevant code in CalloraOrg/Callora-Backend:
CHANGELOG.md.github/copilot-instructions.mdPR_DESCRIPTION_QUOTA_NOTIFICATIONS.md
Priority
Low
Acceptance criteria
- CHANGELOG.md follows a consistent format with Unreleased section
- Breaking API changes are marked
- Contributor guidance mentions the changelog
- Recent features (quotas, webhooks, disputes) have entries
Validation
Review the rendered CHANGELOG.md in a PR.
Non-goals
- Typo-only, formatting-only, or cosmetic changes.
- Unrelated refactors, dependency upgrades, or broad rewrites.
- Removing safeguards or weakening validation to make tests pass.
Contributor application
Before coding, describe the affected modules, proposed state/invariant changes, test strategy, compatibility considerations, and an estimate. Wait for assignment before starting implementation.
PR requirements
Use a feature branch and include Closes #<issue-number>. Address every criterion, map criteria to code and tests, explain security and failure-mode handling, and ensure CI passes.
Quality review
A maintainer will assess correctness, completeness, test depth, compatibility, observability, and adverse-case handling. A substantive implementation is required; merge or CI status alone does not guarantee reward eligibility.
Generated by Claude Code
Summary
CHANGELOG.md is sparse compared with the dozens of PR description files at the root, and there is no guidance in .github/copilot-instructions.md or README on updating it.
Why this matters
Consumers of the API and operators cannot see what changed between deployments, especially for breaking changes caught by the Optic check.
Scope
Adopt Keep a Changelog format, backfill notable entries from existing PR_DESCRIPTION files before they are removed, and document the update rule for contributors.
Relevant code in CalloraOrg/Callora-Backend:
CHANGELOG.md.github/copilot-instructions.mdPR_DESCRIPTION_QUOTA_NOTIFICATIONS.mdPriority
Low
Acceptance criteria
Validation
Review the rendered CHANGELOG.md in a PR.
Non-goals
Contributor application
Before coding, describe the affected modules, proposed state/invariant changes, test strategy, compatibility considerations, and an estimate. Wait for assignment before starting implementation.
PR requirements
Use a feature branch and include
Closes #<issue-number>. Address every criterion, map criteria to code and tests, explain security and failure-mode handling, and ensure CI passes.Quality review
A maintainer will assess correctness, completeness, test depth, compatibility, observability, and adverse-case handling. A substantive implementation is required; merge or CI status alone does not guarantee reward eligibility.
Generated by Claude Code