Docs: Implement CLAUDE.md best practices with modular structure#9
Merged
Conversation
- Refactor CLAUDE.md from 137 to 73 lines (47% reduction) - Create .claude/rules/ directory for progressive disclosure - Add pr-workflow.md, security.md, testing.md rule files - Update .gitignore to commit team-shared config, ignore personal settings - Fix incorrect CLI link (Finesssee/Win-CodexBar → steipete/CodexBar) - Unify all documentation to English - Reduce instruction count from 40+ to ~55 (within 150-200 limit) - Follow official Claude Code best practices for team collaboration
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
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.
Description
This PR implements official Claude Code best practices for CLAUDE.md files, optimizing for the 150-200 instruction limit and enabling team collaboration through modular structure.
Key changes:
.claude/rules/directory for progressive disclosure patternThis follows the "prefer pointers to copies" principle and reduces cognitive load by loading detailed rules only when needed.
Related Issue
N/A
Type of Change
How Has This Been Tested?
This change affects documentation only, no code changes.
Verification performed:
Reviewed all created files for accuracy and completeness
Verified .gitignore correctly excludes
.claude/*.local.*filesConfirmed
.claude/settings.local.jsonis properly ignoredValidated all file references and links are correct
Ensured all content is in English
Manual testing on Windows x64
Manual testing on Windows ARM64
Tested with multiple providers (list which ones)
Test Configuration:
Screenshots (if applicable)
N/A - Documentation changes only
Checklist
Breaking Changes
N/A
Additional Notes
Files changed:
CLAUDE.md- Reduced from 137 to 73 lines, now references modular rule files.claude/rules/pr-workflow.md- PR validation checklist and creation process.claude/rules/security.md- Security rules (provider validation, secrets, GPL).claude/rules/testing.md- Testing requirements and naming conventions.gitignore- Changed from ignoring entire.claude/to only personal settingsBenefits:
References: