📝 docs: standardize and improve Claude commands documentation - #93
Merged
Conversation
- Remove .claude/commands/pr-create.md (Japanese PR creation guide) - Enhance .claude/commands/pr.md with comprehensive English PR guidelines - Add .claude/commands/commit.md with detailed commit best practices and emoji conventions Closes #74 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. WalkthroughAdds a new command doc for “Commit,” overhauls the PR workflow doc in pr.md (English, CLI-driven), and removes the older pr-create.md. The commit doc details automated commit message generation and checks; the PR doc formalizes gh CLI usage, checklists, validators, and size limits. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant Cmd as Commit Command
participant Git as Git
participant Hooks as Pre-commit Checks
Dev->>Cmd: /commit [--no-verify]
Cmd->>Git: Inspect status / stage changes
Cmd->>Git: git diff
Cmd->>Cmd: Analyze diff (split if multi-change)
alt verify enabled
Cmd->>Hooks: Run lint/build/generate:docs
Hooks-->>Cmd: Results
Cmd->>Dev: Abort on failure (if any)
end
Cmd->>Cmd: Generate emoji-conventional message(s)
Cmd->>Git: git commit -m "<message>"
Git-->>Dev: Commit created
sequenceDiagram
participant Dev as Developer
participant GH as GitHub CLI (gh)
participant Repo as Repo/CI
Dev->>Dev: Pre-PR checklist & quality gates
Dev->>GH: gh pr create --draft/ready
GH->>Repo: Open PR using template
Repo-->>Dev: PR URL/status
Dev->>GH: gh pr status/view/checkout
Dev->>GH: gh pr merge (on approval)
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Possibly related PRs
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (3)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
- Add proper spacing and blank lines in commit.md - Fix indentation and spacing in pr.md - Add newlines at end of files to meet prettier requirements Fixes CI formatting check failures. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Standardize and improve the Claude commands documentation by consolidating Japanese and English documentation into comprehensive English guides.
Changes made:
.claude/commands/pr-create.md(Japanese PR creation guide).claude/commands/pr.mdwith comprehensive English PR guidelines including GitHub CLI usage, best practices, troubleshooting, and success criteria.claude/commands/commit.mdwith detailed commit best practices, conventional commit format with emoji mappings, and guidelines for splitting commitsMotivation
The previous documentation was fragmented with some content in Japanese and some in English, with incomplete coverage of best practices. This consolidation provides:
Type of Change
Testing
Quality Checklist
Documentation Impact
Closes #74
Summary by CodeRabbit