Skip to content

Conversation

tpayet
Copy link
Member

@tpayet tpayet commented Jun 6, 2025

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

  • Fresh Start Protocol: Mandatory workflow to always start from latest main
  • Focused Development Rules: Clear DO/DON'T guidelines for what to include in PRs
  • Task Assessment Phase: Process to understand scope before coding
  • Commit Standards: Guidelines for atomic commits and proper formatting
  • PR Quality Checklist: Verification steps before creating PRs

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

  • Cleaner, more focused PRs that are easier to review
  • Reduced risk of introducing unrelated bugs
  • Better git history with atomic commits
  • Faster review and merge cycles

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated development workflow guidelines with a comprehensive, step-by-step protocol for coding agents.
    • Added detailed instructions for task isolation, test-driven development, commit standards, and PR quality control.
    • Introduced a checklist and explicit rules to prevent unrelated changes in pull requests.

- 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>
Copy link
Contributor

coderabbitai bot commented Jun 6, 2025

Walkthrough

The 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

File(s) Change Summary
CLAUDE.md Replaced previous brief TDD/incremental development guidance with a comprehensive, prescriptive workflow covering branch management, test focus, commit standards, prohibited changes, and PR quality checklist.

Possibly related PRs

Poem

🐇
A fresh start for every codey hop,
From main we leap, no time to stop!
With focused branches, tests in tow,
Only what’s needed, steady we go.
Commit by commit, our PRs shine bright—
The CLAUDE way guides us, coding right!


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
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: 0

🧹 Nitpick comments (2)
CLAUDE.md (2)

13-18: Nitpick: add missing article & clarify branch context

Consider 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 creation

Step 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

📥 Commits

Reviewing files that changed from the base of the PR and between f5455b0 and 5f5b701.

📒 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 guideline

The emphasis on enforcing guidelines for every task is explicit and well communicated.


9-11: Fresh Start Protocol introduction

The heading and instruction clearly establish the protocol’s purpose before starting new work.


20-23: Verify clean state step is clear

The directive to check for a clean working directory is precise and actionable.


28-39: Focused Development Rules are comprehensive

The bullet points clearly delineate allowed and disallowed changes, promoting targeted PRs.


42-48: Task Assessment Phase is thorough

The four-step scope assessment process is well-defined and will help prevent scope creep.


49-64: TDD Approach is explicit and actionable

The example commands and numbered steps provide a clear fail–pass–refactor cycle.


66-80: Commit Standards are well-defined

Atomic, focused commits with formatting and test verifications are clearly outlined.


82-89: What NOT to Include is unambiguous

Listing unwanted changes will help maintain PR quality by setting clear boundaries.


90-99: PR Quality Checklist covers all essentials

The checklist is comprehensive and aligns well with the described workflow.


100-100: Rejection warning is strong and clear

The notice sets firm expectations for PR content and review outcomes.

@tpayet tpayet merged commit f338139 into main Jun 6, 2025
3 checks passed
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