microsoft / microsoft/documentdb-mcp
[DX] Establish CHANGELOG with migration notes for breaking changes
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 4
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 3
Description
Goal
Every breaking change documented with a Before: / After: snippet.
What to ship
CHANGELOG.mdat repo root following Keep a Changelog format.- Backfill entries for PR #43 (
allowedDatabases: []semantic flip), PR #44 (allowedRolesdefault, kill-switch removal), PR #47 (denylists,readOnlyif it ships). - Each breaking change has a
Migration:block with a concrete config diff.
Acceptance criteria
- CHANGELOG present and current.
- A pre-merge check or contributor guideline that says "if your PR is breaking, add a CHANGELOG entry."
- Release notes link to CHANGELOG.
Why
PR #44's default flip would have been less surprising with a CHANGELOG. As the user base grows this becomes essential.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing PRs #43, #44, and #47 to identify each breaking change and its configuration impact. Add the root CHANGELOG.md in Keep a Changelog format with Before/After snippets and Migration blocks, then inspect the release notes and contributor-process entry points. Done means the changelog is current, release notes link to it, and breaking PRs are required to add entries.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100