Skip to content

docs(agents): document PR conventions#50

Merged
DavidBabinec merged 1 commit into
mainfrom
docs/agent-pr-conventions
Jun 12, 2026
Merged

docs(agents): document PR conventions#50
DavidBabinec merged 1 commit into
mainfrom
docs/agent-pr-conventions

Conversation

@DavidBabinec

@DavidBabinec DavidBabinec commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds explicit repository workflow and PR naming instructions to CLAUDE.md so future agent sessions follow the repo's existing branch and title conventions.

Changes

  • Documents that main is protected and all changes must go through PRs.
  • Captures branch naming as <type>/<short-kebab-description>.
  • Captures PR titles as <type>(<scope>): <summary>.
  • Explicitly bans agent-branded branch prefixes and PR title prefixes such as codex/... and [codex].
  • Notes draft PR defaults, coherent PR scope, explicit staging, and expected PR body contents.

Validation

  • git diff --check
  • bun run lint

Summary by CodeRabbit

  • Documentation
    • Updated repository contribution guidelines with branch naming conventions, PR formatting standards, and workflow rules to maintain repository integrity and consistency.
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cdcca82b-8c4d-4741-9676-cf1823bf3a78

📥 Commits

Reviewing files that changed from the base of the PR and between c5cbf33 and 9be8b4d.

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

Walkthrough

This PR adds a "Repository workflow and PR conventions" section to CLAUDE.md that documents branch naming conventions, Conventional Commits PR title formatting, draft-by-default guidance, and rules protecting the main branch from direct pushes or bypassed branch protection.

Changes

Repository Workflow Documentation

Layer / File(s) Summary
Workflow and PR conventions documentation
CLAUDE.md
New section documenting branch naming conventions, Conventional Commits PR title format, draft-by-default PR creation guidance, and protected main branch rules.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A document grows, a workflow takes shape,
Branch names and commits in conventional drape,
Main stays protected, drafts lead the way,
Conventions are clear for a cleaner today! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/agent-pr-conventions

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.

@DavidBabinec DavidBabinec marked this pull request as ready for review June 12, 2026 09:40
@DavidBabinec DavidBabinec merged commit 4b70e38 into main Jun 12, 2026
7 checks passed
@DavidBabinec DavidBabinec deleted the docs/agent-pr-conventions branch June 13, 2026 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant