docs: add CLAUDE.md developer guidance file#2216
docs: add CLAUDE.md developer guidance file#2216TheophilusChinomona wants to merge 2 commits intobmad-code-org:mainfrom
Conversation
Provides Claude Code with project context, common commands, architecture overview, coding conventions, and development workflow information. https://claude.ai/code/session_013pCjcYme5oQzb13a9uGDHQ
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughA new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Pull request overview
Adds a CLAUDE.md repository guidance document intended to help AI assistants and developers work effectively in this repo by documenting commands, architecture, and conventions.
Changes:
- Introduces
CLAUDE.mdwith project overview and repo architecture notes - Documents common npm scripts (tests, validation, lint/format, docs)
- Captures key conventions (YAML extension/quoting, formatting, Node version, commit prefixes, hooks)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - File references in CSV files are validated by `npm run validate:refs` - keep them in sync | ||
| - PR target is `main` (trunk-based development) | ||
| - PRs should be 200-400 lines (max 800 excluding generated files) | ||
| - The `website/` directory is excluded from linting |
There was a problem hiding this comment.
"The website/ directory is excluded from linting" is ambiguous/partly inaccurate: it is excluded from ESLint via eslint.config.mjs ignores, but npm run lint:md will still lint website/**/*.md (and CI also builds docs). Consider clarifying this bullet to "excluded from ESLint" (or specifying which tools ignore it).
| - The `website/` directory is excluded from linting | |
| - The `website/` directory is excluded from ESLint; markdownlint still applies to `website/**/*.md` |
| ### Run all checks (equivalent to CI) | ||
|
|
||
| ```bash | ||
| npm test | ||
| ``` | ||
|
|
||
| This runs, in order: schema tests, file ref tests, installation tests, schema validation, ESLint, markdownlint, and Prettier checks. | ||
|
|
There was a problem hiding this comment.
This section describes npm test as "equivalent to CI", but CI runs additional checks that npm test does not (e.g., npm run validate:refs and npm run docs:build in .github/workflows/quality.yaml). Either adjust the wording to reflect that npm test is a subset, or update the commands listed here to match CI more closely.
What
Added
CLAUDE.mdto provide comprehensive guidance for Claude Code when working in this repository, covering project overview, common commands, architecture, conventions, and important notes.Why
This file serves as a reference document for AI assistants and developers working with the BMad Method framework, ensuring consistency in understanding the project structure, tooling, and conventions. It reduces onboarding friction and helps maintain code quality standards across contributions.
How
CLAUDE.mdwith sections covering project overview, common npm commands, directory architecture, key conventions (YAML, formatting, Node version), commit message prefixes, pre-commit hooks, and important development notesTesting
N/A - This is documentation content with no functional code changes.
https://claude.ai/code/session_013pCjcYme5oQzb13a9uGDHQ