Skip to content

docs: improve CLAUDE.md and add path-scoped rules#497

Merged
colinscz merged 1 commit intosix-group:mainfrom
deanmarti:claude-md-improvements
Mar 27, 2026
Merged

docs: improve CLAUDE.md and add path-scoped rules#497
colinscz merged 1 commit intosix-group:mainfrom
deanmarti:claude-md-improvements

Conversation

@deanmarti
Copy link
Copy Markdown
Contributor

Summary

  • Improved .claude/CLAUDE.md: Added prerequisites, screenshot update command, key source directories, important rules (auto-generated files, changelog, shadow DOM, CI clean state), PR guidelines, and testing overview
  • Added .claude/rules/component-development.md: Path-scoped rules for Stencil component patterns, naming conventions, and new component workflow (loads only when working in libraries/ui-library/src/components/)
  • Added .claude/rules/docs.md: Path-scoped rules for VitePress documentation, changelog format, and deployment base path (loads only when working in docs/)
  • Added .claude/rules/wrapper-libraries.md: Path-scoped rules highlighting auto-generated code warnings and Vue v-model bindings (loads only when working in wrapper library directories)

All files follow Anthropic's CLAUDE.md best practices:

  • Main CLAUDE.md is 116 lines (under 200-line recommended limit)
  • Rules use paths: frontmatter for on-demand loading
  • Content is actionable, non-obvious, and verified against the actual codebase
  • No duplication with the existing Playwright testing skill

Test plan

  • Verify CLAUDE.md loads correctly with claude /memory from repo root
  • Verify rules load on-demand when working in scoped directories
  • Confirm all listed commands work as documented

🤖 Generated with Claude Code

@colinscz colinscz self-requested a review March 20, 2026 12:15
colinscz
colinscz previously approved these changes Mar 23, 2026
Copy link
Copy Markdown
Collaborator

@colinscz colinscz left a comment

Choose a reason for hiding this comment

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

LGTM! Can be merged after issues with e2e tests and prettier are resolved. Can you please have a look at those @deanmarti ?

Add prerequisites, key source directories, important rules, PR
guidelines, and testing overview to CLAUDE.md. Add path-scoped rules
for component development, docs, and wrapper libraries. Fix prettier
formatting.
@deanmarti deanmarti force-pushed the claude-md-improvements branch from a20cf77 to 99e5d2d Compare March 26, 2026 23:04
Copy link
Copy Markdown
Collaborator

@colinscz colinscz left a comment

Choose a reason for hiding this comment

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

LGTM! Will ignore the upload report issue which posts the playwright result for now since all tests passed

@colinscz colinscz merged commit f552bb5 into six-group:main Mar 27, 2026
3 of 4 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.

2 participants