Skip to content

docs: add Cursor Changelog Drafter example (#223)#357

Open
shixi-li wants to merge 2 commits into
cobusgreyling:mainfrom
shixi-li:docs/cursor-changelog-drafter
Open

docs: add Cursor Changelog Drafter example (#223)#357
shixi-li wants to merge 2 commits into
cobusgreyling:mainfrom
shixi-li:docs/cursor-changelog-drafter

Conversation

@shixi-li

@shixi-li shixi-li commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Add a Cursor-specific Changelog Drafter example that scans merged changes into a two-file draft workspace and requires explicit human review before any publish action.

Changes

  • New pattern or starter (followed templates/pattern-template.md + updated registry.yaml)
  • Doc / example improvement
  • Tool change (loop-audit)
  • Story (includes real failure or surprise + lesson)

The example:

  • maps Cursor Automations, changelog-scan, draft-release-notes, and changelog-drafter-state.md;
  • uses a schedule or supported GitHub/webhook trigger tied to the release workflow;
  • limits planned week-one output to RELEASE_NOTES_DRAFT.md and the state file while explaining that .cursor/rules is advisory;
  • requires source citations, scan-window tracking, and prominent breaking/security review;
  • relies on tool and repository scopes to deny tags, GitHub Releases, Discussions posts, PR creation/merge, and notifications; and
  • links the existing starter, pattern, safety guidance, and week-one story.

The Cursor index and pattern-coverage matrix now link the example.

Checklist (from CONTRIBUTING)

  • Links work from README, patterns/README, starters/README, docs/index
  • No secrets, tokens, internal company URLs
  • Safety-sensitive guidance references docs/safety.md and includes an explicit publish gate
  • Ran node tools/loop-audit/dist/cli.js . and addressed findings

Testing / Dogfood

  • bash scripts/ci-validate-gates.sh
  • bash scripts/ci-audit-gates.sh
  • bash scripts/before-after-demo.sh
  • node tools/loop-audit/dist/cli.js . --json — 100/100, L3
  • git diff --check
  • Manually checked local links and current official Cursor Automations documentation

Screenshots / Examples

Not applicable; this is a Markdown-only documentation change. The new page includes the copy-paste draft-only prompt, human publish checklist, and example state.

Closes #223

@shixi-li
shixi-li requested a review from cobusgreyling as a code owner July 23, 2026 06:53
@github-actions

Copy link
Copy Markdown
Contributor

Thanks @shixi-li for contributing a tool example — visible, reviewable PRs like this grow the reference for everyone.

What happens next

  • Maintainer aims for same-day review on story, adopter, and scoped docs/example PRs (CONTRIBUTING.md).
  • good first issue PRs: comment on the linked issue so we can assign and close on merge.

More ways to help

— loop-engineering maintainers

@shixi-li
shixi-li force-pushed the docs/cursor-changelog-drafter branch from 88da496 to 57b5798 Compare July 23, 2026 06:56
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.

Add Cursor Changelog Drafter example doc

1 participant