Skip to content

Conversation

@aspiers
Copy link
Contributor

@aspiers aspiers commented Jan 19, 2026

Summary by CodeRabbit

  • Documentation
    • Added a new guide on writing changesets describing when to create them, required format and frontmatter, examples (including schema and breaking changes), and guidance for descriptions.
    • Updated agent guidance to mandate creating changesets for relevant changes, provide expanded versioning examples, clarify when to create changesets, and state that releases must be performed manually by maintainers.

✏️ Tip: You can customize this high-level summary in your review settings.

@changeset-bot
Copy link

changeset-bot bot commented Jan 19, 2026

⚠️ No Changeset found

Latest commit: 40cf978

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link

coderabbitai bot commented Jan 19, 2026

📝 Walkthrough

Walkthrough

This change adds a new documentation skill at .claude/skills/writing-changesets/SKILL.md that explains how to create and format changeset files for user-facing changes, and updates AGENTS.md to reference that skill and to strengthen/clarify changesets and release guidance for agents.

Changes

Cohort / File(s) Summary
Changeset Documentation
​.claude/skills/writing-changesets/SKILL.md
New skill document describing when to use changesets, the required .changeset/ Markdown format, per-package frontmatter fields, description guidance, and example changesets. References key files like .changeset/config.json and package.json.
Agent Guidance Updates
AGENTS.md
Reworked changesets guidance: replaced prescriptive interactive commands with instruction to use the writing-changesets skill, reformatted checklist bullets, expanded versioning and example scenarios, added mandatory steps/warnings (create changeset for relevant changes, do not perform releases), and reorganized sections for emphasis.

Sequence Diagram(s)

(omitted — changes are documentation and guidance updates, not new multi-component control flow)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

I nibble notes and tidy tracks,
A changeset map within my stack. 🐇
Write the file, then hop away,
Docs in order—hip hooray! ✨


Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error)
Check name Status Explanation Resolution
Lexicon Documentation Sync ❌ Error PR adds 16 lexicon JSON files but fails to document two of them in README.md: app.certified.defs and com.atproto.repo.strongRef. Update README.md to add formal documentation sections for app.certified.defs and com.atproto.repo.strongRef following the standard format with Lexicon ID header, description, properties table, and key information.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a new AI skill documentation for writing changesets, which is reflected in the new SKILL.md file and AGENTS.md updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In @.claude/skills/writing-changesets/SKILL.md:
- Around line 76-84: The breaking-change example in SKILL.md uses
`"@hypercerts-org/lexicon": major`, which contradicts the repo rule that 0.x
packages must use `minor`; update the markdown example so the bump type reads
`"@hypercerts-org/lexicon": minor` (i.e., replace the `major` token with `minor`
in the front-matter block) so agents and docs align with 0.x guidance.
🧹 Nitpick comments (1)
.claude/skills/writing-changesets/SKILL.md (1)

21-21: Clarify “build scripts” exception to avoid contradicting earlier guidance.
The line suggests skipping changesets for “build scripts,” but earlier guidance requires changesets for generation scripts that affect exports. Consider narrowing this to “build tooling changes that do not affect generated outputs or public API.”

@bitbeckers bitbeckers self-requested a review January 19, 2026 22:16
@aspiers aspiers merged commit 4c8968b into hypercerts-org:develop Jan 19, 2026
3 checks passed
@aspiers aspiers deleted the changeset-skill branch January 19, 2026 22:17
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.

2 participants