Skip to content

Commit d0a4162

Browse files
authored
Clarify changelog guidelines for user-facing changes
2 parents 5248c1a + a5ab98d commit d0a4162

2 files changed

Lines changed: 2 additions & 13 deletions

File tree

CHANGELOG.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10-
### Added
11-
12-
- Unit test to verify README help section stays in sync with `mcpc --help` output
13-
- Experimental feature warning for `x402 init` and `x402 import` commands
14-
- Windows E2E tests via manual-dispatch GitHub Actions workflow (`e2e-windows.yml`) — cross-platform test framework with MSYS path conversion, cached `tasklist` process detection, graceful bridge shutdown via IPC, and Windows named pipe support
15-
16-
### Changed
17-
18-
- Reordered `mcpc --help` to show Commands before Options for better discoverability
19-
- Increased `grep` instructions snippet context from 35 to 40 characters and wrapped snippets in backtick guards for clearer AI agent consumption
20-
2110
### Security
2211

2312
- Fixed XSS vulnerability in OAuth callback server: error messages from query parameters are now HTML-escaped before rendering

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,7 @@ After lint passes, run `npm run build` and fix any TypeScript compilation errors
603603

604604
After build passes, run `npm run test:unit` and fix any failures before committing. If a test fails due to your changes, update the test or fix the code so all tests pass. Never commit code that fails unit tests.
605605

606-
For any non-trivial change (new feature, bug fix, behaviour change, or notable refactor), add an entry to the `[Unreleased]` section of `CHANGELOG.md` before finishing. Use the appropriate category (`Added`, `Changed`, `Fixed`, `Removed`). Skip purely internal changes such as test-only edits, code style fixes, or minor cosmetic/styling tweaks (e.g. changing colors, adjusting whitespace, renaming labels).
606+
For any non-trivial change (new feature, bug fix, behaviour change, or notable refactor), add an entry to the `[Unreleased]` section of `CHANGELOG.md` before finishing. Use the appropriate category (`Added`, `Changed`, `Fixed`, `Removed`). Skip purely internal changes such as test-only edits, code style fixes, or minor cosmetic/styling tweaks (e.g. changing colors, adjusting whitespace, renaming labels). The changelog is for **users reading release notes** — only include entries that a user would care about. Do not add entries for: new warnings or deprecation notices on existing commands, minor help text changes, test infrastructure, CI/CD changes, or internal refactors. When in doubt, leave it out.
607607

608608
When implementing features:
609609

@@ -769,7 +769,7 @@ The `CHANGELOG.md` file follows [Keep a Changelog](https://keepachangelog.com/en
769769
2. Ensure all significant changes are documented in `[Unreleased]`
770770
3. The release script will automatically move `[Unreleased]` entries to the new version section
771771

772-
**Important:** Always keep user-facing changes documented. Internal refactoring or test changes don't need changelog entries unless they affect behavior.
772+
**Important:** The changelog is for **users reading release notes**. Only include entries that a user would care about. Do not add entries for: new warnings or deprecation notices on existing commands, minor help text or `--help` output changes, test infrastructure (new tests, test refactors), CI/CD workflow changes, internal refactors, or cosmetic tweaks. When in doubt, leave it out.
773773

774774
# Misc
775775

0 commit comments

Comments
 (0)