Skip to content

docs: add changeset requirement to agent guidelines#334

Merged
HugoRCD merged 2 commits intomainfrom
docs/agents-changeset-rule
May 9, 2026
Merged

docs: add changeset requirement to agent guidelines#334
HugoRCD merged 2 commits intomainfrom
docs/agents-changeset-rule

Conversation

@HugoRCD
Copy link
Copy Markdown
Owner

@HugoRCD HugoRCD commented May 9, 2026

Adds a mandatory changeset rule to AGENTS.md so agents always include a changeset when working on user-facing changes.

Changes:

  • New Changesets subsection under Conventions, explaining when to add a changeset, when it can be skipped, bump types, and description style
  • Added item 7 to Definition of Done: changeset required for user-facing changes
  • Added to Boundaries > Always do: run pnpm changeset for features, fixes, breaking changes
  • Added to Boundaries > Never: open a PR for a user-facing change without a changeset

Summary by CodeRabbit

  • Documentation
    • Strengthened guidelines: all user-facing changes now require a committed changeset, with guidance on when to add one and suggested version bump levels.
    • "Definition of Done" and "Boundaries → Always do" updated to require changesets.
    • Explicit prohibition on opening a PR for a user-facing change without an accompanying changeset.

Review Change Stack

@vercel
Copy link
Copy Markdown

vercel Bot commented May 9, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
evlog-docs Ready Ready Preview, Comment, Open in v0 May 9, 2026 5:58pm
just-use-evlog Ready Ready Preview, Comment May 9, 2026 5:58pm

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 9, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 9, 2026

Thank you for following the naming conventions! 🙏

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 9, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 344db9e3-9804-4b5a-bcd4-98a6c8c42565

📥 Commits

Reviewing files that changed from the base of the PR and between 8791cb1 and 37ab0f7.

📒 Files selected for processing (1)
  • AGENTS.md

📝 Walkthrough

Walkthrough

This PR updates AGENTS.md project guidelines to enforce changeset requirements for all user-facing changes. A new "Changesets" section documents when and how to create changesets, the Definition of Done checklist now requires changesets, the Boundaries section includes a changeset requirement, and a "Never" rule explicitly prohibits opening PRs without changesets for user-facing changes.

Changes

Changeset Documentation Requirements

Layer / File(s) Summary
Guidelines and enforcement requirements
AGENTS.md
Added "Changesets" section with guidance on bump types and commit requirements; extended Definition of Done and Boundaries sections with explicit changeset requirements; added "Never" rule prohibiting PRs without changesets for user-facing changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • HugoRCD/evlog#334: Same documentation change to AGENTS.md making changesets mandatory for user-facing changes.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description provides a comprehensive overview of changes but does not include a linked issue or the required documentation checklist section from the template. Add a linked issue reference and complete the checklist from the template with appropriate checkmarks for documentation updates.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding a changeset requirement to agent guidelines documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/agents-changeset-rule

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

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 9, 2026

npm i https://pkg.pr.new/evlog@334
npm i https://pkg.pr.new/@evlog/nuxthub@334

commit: 8791cb1

Copy link
Copy Markdown
Contributor

@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

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Line 56: Replace the sentence "Before opening a PR — especially for features,
but also for bug fixes and breaking changes — run `pnpm changeset` and commit
the generated `.changeset/*.md` file alongside the code." in AGENTS.md with a
simpler, clearer variant that removes "especially" and lists the change types
equally (e.g., "Before opening a PR — for features, bug fixes, and breaking
changes — run `pnpm changeset` and commit the generated `.changeset/*.md` file
alongside the code.") so it clearly states that changesets are required for all
user-facing changes.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: e36cc4a2-c0d6-40d8-a102-5abdf11e8dcb

📥 Commits

Reviewing files that changed from the base of the PR and between 402f27b and 8791cb1.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@HugoRCD HugoRCD merged commit d74539d into main May 9, 2026
9 of 12 checks passed
@HugoRCD HugoRCD deleted the docs/agents-changeset-rule branch May 9, 2026 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant