Skip to content

docs: update CLAUDE.md with behavioral guidelines and project-specifi…#21

Merged
NeverMore93 merged 1 commit into
masterfrom
dev_master_260422
Apr 22, 2026
Merged

docs: update CLAUDE.md with behavioral guidelines and project-specifi…#21
NeverMore93 merged 1 commit into
masterfrom
dev_master_260422

Conversation

@NeverMore93
Copy link
Copy Markdown
Owner

@NeverMore93 NeverMore93 commented Apr 22, 2026

…c instructions

Summary by CodeRabbit

  • Documentation
    • Added repository governance documentation defining roles and responsibilities across development directories
    • Updated core project guidelines with behavioral standards for development workflows

@NeverMore93 NeverMore93 merged commit 4744e4a into master Apr 22, 2026
1 of 2 checks passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 22, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 57effeff-07b9-455e-9ca1-9d0a4133b4e6

📥 Commits

Reviewing files that changed from the base of the PR and between 169b66c and 4b04555.

📒 Files selected for processing (15)
  • .claude/CLAUDE.md
  • .claude/commands/CLAUDE.md
  • .github/CLAUDE.md
  • .github/workflows/CLAUDE.md
  • .gitignore
  • .specify/CLAUDE.md
  • .specify/memory/CLAUDE.md
  • .specify/scripts/CLAUDE.md
  • .specify/scripts/powershell/CLAUDE.md
  • .specify/templates/CLAUDE.md
  • CLAUDE.md
  • doc/plugin-sdk-api.md
  • src/CLAUDE.md
  • tests/CLAUDE.md
  • tests/unit/CLAUDE.md

📝 Walkthrough

Walkthrough

The pull request establishes directory-level ownership and responsibility boundaries across the repository through CLAUDE.md documentation files. Multiple directories receive new ownership documentation defining their scope, what they contain, and explicit constraints. The root CLAUDE.md is restructured with behavioral guidelines. A doc directory is added to .gitignore.

Changes

Cohort / File(s) Summary
Root Behavioral Guidelines
CLAUDE.md
Replaced "What This Project Is" section with new behavioral guidelines on pre-implementation thinking, simplicity-first coding, surgical changes, and goal-driven execution with success criteria. Renamed and reorganized subsequent section headers under "Project-Specific Guidelines".
Core Directory Ownership Documentation
.claude/CLAUDE.md, .specify/CLAUDE.md, src/CLAUDE.md
Added new ownership documentation defining directory role, owned components, and constraints. Includes explicit guidance on scope boundaries and what to avoid (e.g., avoiding product runtime logic in configuration directories, keeping runtime plugin code separate).
Nested Directory Governance
.claude/commands/CLAUDE.md, .specify/scripts/CLAUDE.md, .specify/memory/CLAUDE.md, .specify/scripts/powershell/CLAUDE.md, .specify/templates/CLAUDE.md
Added or replaced ownership documentation for nested directories. Removed prior memory-context activity blocks and replaced with structured role/owns/avoid documentation defining responsibilities for scripts, templates, and generated context management.
GitHub Automation Governance
.github/CLAUDE.md, .github/workflows/CLAUDE.md
Added repository governance documentation defining responsibilities for workflows and automation, including trigger rules, job graphs, permissions, and constraints on expanding permissions or secret usage without explicit release/security requirements.
Test Directory Ownership
tests/CLAUDE.md, tests/unit/CLAUDE.md
Added test ownership documentation specifying directory scope (fast, deterministic checks), organization boundaries, and constraints against duplicating production logic and including flaky/external dependencies in tests.
Build Configuration
.gitignore
Added doc to the ignore list, excluding that top-level directory from version control.
API Documentation Reference
doc/plugin-sdk-api.md
Added new documentation file containing a filesystem path reference with no trailing newline.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Directories now have homes so clear,
With roles and rules for all to hear!
No scope creep in this warren, dear—
Each burrow knows its purpose here.
Organization is the way,
To keep good chaos at bay! 🌿

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev_master_260422

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.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request establishes a structured documentation framework for LLM interactions by adding and updating CLAUDE.md files throughout the repository. These files define directory-specific roles, ownership, and boundaries, while the root CLAUDE.md is expanded with core behavioral principles such as "Simplicity First" and "Surgical Changes." A contradiction was identified where the doc directory was added to .gitignore despite the inclusion of a tracked file within that same directory, which also violates the newly established principle of surgical changes.

Comment thread .gitignore
# specs (development-only, not shipped)
specs/

doc
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Adding doc to .gitignore while simultaneously committing a tracked file in doc/plugin-sdk-api.md is contradictory. Furthermore, this change is unrelated to the PR's focus on CLAUDE.md files and should be removed to maintain surgical changes.

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