Skip to content

docs: add per-package CHANGELOG.md for sdk-libs crates #2314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
klausundklaus wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add per-package CHANGELOG.md for sdk-libs crates #2314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions sdk-libs/account-pinocchio/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/account/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/compressed-token-sdk/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/event/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/instruction-decoder-derive/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/instruction-decoder/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/macros/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/program-test/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/sdk-pinocchio/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/sdk/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/token-client/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/token-pinocchio/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
3 changes: 3 additions & 0 deletions sdk-libs/token-sdk/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

All notable changes to this package will be documented in this file.
Comment on lines +1 to +3
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 25, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Inspect existing CHANGELOG.md files (excluding sdk-libs) to determine format conventions
fd -g "CHANGELOG.md" --exclude "sdk-libs" --exec head -20 {} \; -exec echo "---FILE_END---" \;

Repository: Lightprotocol/light-protocol

Length of output: 428

🏁 Script executed:

# Count total CHANGELOG.md files in sdk-libs to verify the "13 new files" claim
find sdk-libs -name "CHANGELOG.md" | wc -l

Repository: Lightprotocol/light-protocol

Length of output: 74

🏁 Script executed:

# List all new CHANGELOG.md files in sdk-libs to see the scope
find sdk-libs -name "CHANGELOG.md" | sort

Repository: Lightprotocol/light-protocol

Length of output: 596

🏁 Script executed:

# Check if any existing changelogs use the Keep a Changelog format with [Unreleased]
rg "\[Unreleased\]" --type markdown

Repository: Lightprotocol/light-protocol

Length of output: 247

🏁 Script executed:

# Check the format of existing sdk-libs changelogs that have [Unreleased]
echo "=== sdk-libs/photon-api/CHANGELOG.md ===" && head -15 sdk-libs/photon-api/CHANGELOG.md
echo ""
echo "=== sdk-libs/client/CHANGELOG.md ===" && head -15 sdk-libs/client/CHANGELOG.md

Repository: Lightprotocol/light-protocol

Length of output: 961

🏁 Script executed:

# Search for stateless.js and compressed-token changelogs outside sdk-libs
fd -g "CHANGELOG.md" -exclude "sdk-libs" && rg -l "stateless|compressed-token" --type markdown

Repository: Lightprotocol/light-protocol

Length of output: 1980

🏁 Script executed:

# Check the specific file being reviewed
head -20 sdk-libs/token-sdk/CHANGELOG.md

Repository: Lightprotocol/light-protocol

Length of output: 153

🏁 Script executed:

# Check the format of the external changelogs mentioned in the review
echo "=== js/compressed-token/CHANGELOG.md ===" && head -15 js/compressed-token/CHANGELOG.md
echo ""
echo "=== js/stateless.js/CHANGELOG.md ===" && head -15 js/stateless.js/CHANGELOG.md

Repository: Lightprotocol/light-protocol

Length of output: 1858

🏁 Script executed:

# Check which sdk-libs changelogs already have the full scaffold vs minimal
for file in $(find sdk-libs -name "CHANGELOG.md"); do
  lines=$(wc -l < "$file")
  echo "$file: $lines lines"
done

Repository: Lightprotocol/light-protocol

Length of output: 733

🏁 Script executed:

# Check CLAUDE.md and other convention docs for changelog guidance
find . -name "CLAUDE.md" -o -name "CONVENTIONS.md" | head -5 | xargs -I {} sh -c 'echo "=== {} ===" && head -50 {}'

Repository: Lightprotocol/light-protocol

Length of output: 13529

Adopt the full Keep a Changelog scaffold with an ## [Unreleased] section.

The current 3-line boilerplate lacks structure. The existing sdk-libs/client and sdk-libs/photon-api changelogs already follow the Keep a Changelog standard with an [Unreleased] section at the top—this pattern should extend to all other sdk-libs changelogs for consistency. The [Unreleased] section provides a clear landing zone for contributors to add entries before the next release, preventing files from remaining empty until the last minute.

The pattern used in client and photon-api:

✨ Standard scaffold (applies to all 15 new sdk-libs CHANGELOG.md files) 
 # Changelog
 
 All notable changes to this package will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Changelog
All notable changes to this package will be documented in this file.
# Changelog
All notable changes to this package will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@sdk-libs/token-sdk/CHANGELOG.md` around lines 1 - 3, Add a top-level "##
[Unreleased]" section to this CHANGELOG.md and adopt the full Keep a Changelog
scaffold used in other sdk-libs (e.g., include sections like Added, Changed,
Deprecated, Removed, Fixed, Security under the Unreleased header and an example
release template below), so contributors have a clear place to add entries;
update the existing 3-line boilerplate to include the "## [Unreleased]" header
followed by the standard subsection headings and an example past-release entry
to match the pattern used in sdk-libs/client and sdk-libs/photon-api.