-
Notifications
You must be signed in to change notification settings - Fork 19
Update CLAUDE.md with focused development workflow guidelines #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Add Fresh Start Protocol: always start from latest main - Add Focused Development Rules: only change files related to specific task - Add Task Assessment Phase: understand requirements before coding - Add Commit Standards: atomic commits with proper formatting - Add PR Quality Checklist: verification steps before creating PRs - Prevent scope creep and unrelated changes in future PRs This will ensure all future coding agents create clean, focused PRs that only address the specific issue without including unrelated changes. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
WalkthroughThe CLAUDE.md documentation was extensively rewritten to establish a strict, stepwise workflow for development within the repository. The new version introduces the "Fresh Start Protocol," prescribes focused branch and commit practices, clarifies TDD steps, and adds explicit requirements for PR content and quality, replacing previous, less detailed guidance. Changes
Possibly related PRs
Poem
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. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
CLAUDE.md (2)
13-18
: Nitpick: add missing article & clarify branch contextConsider rephrasing step 1 to:
1. **Always start from the latest `main` branch**:This adds “the” and specifies “branch” for clarity.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: You might be missing the article “the” here.
Context: ...ask or issue:** 1. Always start from latest main: ```bash git checkout main...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
25-26
: Nitpick: improve wording for branch creationStep 4 could read:
4. **Create a focused branch for each task from the latest `main` branch**for consistency and clarity.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~26-~26: You might be missing the article “the” here.
Context: ...task gets its own focused branch** from latest main ### 🎯 Focused Development Rules ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CLAUDE.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CLAUDE.md
[uncategorized] ~13-~13: You might be missing the article “the” here.
Context: ...ask or issue:** 1. Always start from latest main: ```bash git checkout main...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~26-~26: You might be missing the article “the” here.
Context: ...task gets its own focused branch** from latest main ### 🎯 Focused Development Rules ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🔇 Additional comments (10)
CLAUDE.md (10)
7-7
: Clear mandatory guidelineThe emphasis on enforcing guidelines for every task is explicit and well communicated.
9-11
: Fresh Start Protocol introductionThe heading and instruction clearly establish the protocol’s purpose before starting new work.
20-23
: Verify clean state step is clearThe directive to check for a clean working directory is precise and actionable.
28-39
: Focused Development Rules are comprehensiveThe bullet points clearly delineate allowed and disallowed changes, promoting targeted PRs.
42-48
: Task Assessment Phase is thoroughThe four-step scope assessment process is well-defined and will help prevent scope creep.
49-64
: TDD Approach is explicit and actionableThe example commands and numbered steps provide a clear fail–pass–refactor cycle.
66-80
: Commit Standards are well-definedAtomic, focused commits with formatting and test verifications are clearly outlined.
82-89
: What NOT to Include is unambiguousListing unwanted changes will help maintain PR quality by setting clear boundaries.
90-99
: PR Quality Checklist covers all essentialsThe checklist is comprehensive and aligns well with the described workflow.
100-100
: Rejection warning is strong and clearThe notice sets firm expectations for PR content and review outcomes.
Summary
Updates CLAUDE.md with comprehensive focused development workflow guidelines to prevent future PRs from including unrelated changes and ensure clean, atomic commits.
Key Changes
Problem Solved
Previous PRs have included unrelated changes (formatting, comprehensive test suites, etc.) that should not be part of focused issue fixes. These guidelines will ensure all future coding agents create clean, targeted PRs.
Impact
🤖 Generated with Claude Code
Summary by CodeRabbit