docs: add CHANGELOG.md and release documentation guidelines #362
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
coderdan
commented
Jan 29, 2026
coderdan
commented
- Add CHANGELOG.md following Keep a Changelog format, starting with v2.1.20 release (performance diagnostics, term filters)
- Add release documentation section to CLAUDE.md with instructions for maintaining the changelog and writing announcements
- Add CHANGELOG.md following Keep a Changelog format with full release history from v2.0.0 through v2.1.20 - Add release documentation section to CLAUDE.md with instructions for maintaining the changelog and writing announcements
coderdan
force-pushed
the
docs/add-changelog
branch
from
e5dbbd8 to
8effe72
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive release documentation infrastructure to the CipherStash Proxy project. It introduces a CHANGELOG.md following the Keep a Changelog format and adds detailed release documentation guidelines to CLAUDE.md.
Changes:
- Added CHANGELOG.md with version history from v2.0.0 through v2.1.20, documenting features, fixes, and changes
- Added release documentation section to CLAUDE.md with changelog maintenance instructions and release announcement guidelines
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CLAUDE.md | Added comprehensive release documentation section with changelog maintenance guidelines and release announcement template instructions |
| CHANGELOG.md | New file containing complete version history following Keep a Changelog format, including version links and categorized changes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.