Skip to content

chore: add changelog for release notes#510

Merged
ovitrif merged 2 commits intomasterfrom
chore/add-changelog
Mar 31, 2026
Merged

chore: add changelog for release notes#510
ovitrif merged 2 commits intomasterfrom
chore/add-changelog

Conversation

@ovitrif
Copy link
Copy Markdown
Collaborator

@ovitrif ovitrif commented Mar 30, 2026

This PR adds a CHANGELOG.md system following Keep a Changelog format so developers can document user-facing changes as part of their PR workflow. Mirrors the setup from synonymdev/bitkit-android#874.

Description

  1. Creates CHANGELOG.md with an empty [Unreleased] section (no backfilling)
  2. Adds an HTML comment to the PR template reminding contributors to update the changelog
  3. Adds changelog rules to AGENTS.md
  4. Updates /release command to finalize changelog entries into versioned sections and use them as primary source for store release notes
  5. Updates /pr command to backfill PR numbers into changelog entries after PR creation

Linked Issues/Tasks

Screenshot / Video

N/A

QA Notes

  1. Verify CHANGELOG.md follows keepachangelog.com format
    • ## [Unreleased] section present
    • Compare link at bottom points to v2.1.2...HEAD
  2. Verify PR template comment is invisible in rendered view but visible in edit mode
  3. Verify changelog rules in AGENTS.md match the Android counterpart
  4. Verify /release command changes:
    • New Step 2c reads and finalizes changelog
    • Step 3 includes CHANGELOG.md in the version bump commit
    • Step 6 uses changelog as primary source for store notes
  5. Verify /pr command Step 8b backfills PR numbers into changelog entries

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ovitrif ovitrif requested review from piotr-iohk and pwltr March 30, 2026 16:15
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@claude
Copy link
Copy Markdown

claude bot commented Mar 30, 2026

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@ovitrif ovitrif enabled auto-merge March 30, 2026 17:05
Copy link
Copy Markdown
Collaborator

@piotr-iohk piotr-iohk left a comment

Choose a reason for hiding this comment

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

LGTM

@ovitrif ovitrif merged commit 1dc6bd3 into master Mar 31, 2026
18 checks passed
@ovitrif ovitrif deleted the chore/add-changelog branch March 31, 2026 13:05
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.

2 participants