Skip to content

docs: add REST API and branch protection guidance#494

Merged
mherod merged 2 commits intomainfrom
docs/claude-md-rest-api-guidance
Mar 15, 2026
Merged

docs: add REST API and branch protection guidance#494
mherod merged 2 commits intomainfrom
docs/claude-md-rest-api-guidance

Conversation

@mherod
Copy link
Copy Markdown
Owner

@mherod mherod commented Mar 15, 2026

Summary

  • Clarify branch protection applies even in solo repos — always use feature branches
  • Add new section: GitHub API — prefer REST over GraphQL, with concrete command examples for PR creation, merging, branch updates, and CI checks

Test plan

  • Pre-commit hooks pass (biome format)
  • Docs-only change, no code impact

Copy link
Copy Markdown

@claude claude bot left a comment

Choose a reason for hiding this comment

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

PR Review: CLAUDE.md guidance improvements

Overview

Two focused improvements to the release/workflow guidance in CLAUDE.md: clarifying that branch protection applies universally (including solo repos), and adding a practical REST-over-GraphQL section with concrete gh api examples.

Findings

No issues found.

👍 What's Good

  • The branch protection clarification is useful — the "even in a solo/personal repo" note prevents a common surprise
  • Generalizing the branch example from chore/release-<version> to <type>/<slug>-<issue-number> makes it applicable beyond release workflows
  • The REST API examples use gh's :owner/:repo substitution correctly and cover the main PR operations (create, merge, update-branch, CI check)
  • The rate-limit rationale is a good reason for the preference — keeps the guidance grounded

LGTM ✅

@mherod mherod merged commit 2ee86e4 into main Mar 15, 2026
24 checks passed
@mherod mherod deleted the docs/claude-md-rest-api-guidance branch March 15, 2026 20:55
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.

1 participant