-
Notifications
You must be signed in to change notification settings - Fork 26
docs: add CLAUDE.md for Claude Code guidance #452
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Provides context for Claude Code when working in this repository: - Build, test, and lint commands - Workspace structure (lib, cli, clap_usage) - Architecture overview (spec model, completions, parsing, docs) - KDL spec format example - Testing notes (insta snapshots, shell integration) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds a CLAUDE.md file to provide Claude Code with essential context about the repository's structure, commands, and architecture when working with the codebase.
Changes:
- Adds comprehensive documentation covering build/test commands, workspace structure, and architecture
- Includes KDL spec format examples and testing guidelines
- Lists key dependencies and their purposes
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #452 +/- ##
==========================================
- Coverage 47.72% 47.66% -0.07%
==========================================
Files 47 47
Lines 6925 6928 +3
Branches 6925 6928 +3
==========================================
- Hits 3305 3302 -3
- Misses 1777 1780 +3
- Partials 1843 1846 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
### 🚀 Features - **(lint)** add more lint checks by [@jdx](https://github.com/jdx) in [#446](#446) - add logo to docs site by [@jdx](https://github.com/jdx) in [#442](#442) - add VT323 retro terminal font and --usage branding by [@jdx](https://github.com/jdx) in [#443](#443) - add missing builder methods by [@jdx](https://github.com/jdx) in [#444](#444) ### 🐛 Bug Fixes - use pithy LLM-generated title for GitHub releases by [@jdx](https://github.com/jdx) in [#441](#441) - replace unwrap calls with proper error handling in fig.rs by [@jdx](https://github.com/jdx) in [#454](#454) - improve error messages with more context by [@jdx](https://github.com/jdx) in [#449](#449) - skip powershell test if pwsh is not installed by [@jdx](https://github.com/jdx) in [#457](#457) - match completion prefix against unescaped names by [@ilyagr](https://github.com/ilyagr) in [#460](#460) ### 🚜 Refactor - simplify Spec::merge with local macros by [@jdx](https://github.com/jdx) in [#451](#451) ### 📚 Documentation - add CLAUDE.md for Claude Code guidance by [@jdx](https://github.com/jdx) in [#452](#452) - escape generic type parameters in macro doc comments by [@jdx](https://github.com/jdx) in [#453](#453) - add rustdoc for public API functions by [@jdx](https://github.com/jdx) in [#450](#450) - add documentation to public API structs by [@jdx](https://github.com/jdx) in [#455](#455) - add conventional commit guidance to CLAUDE.md by [@jdx](https://github.com/jdx) in [#459](#459) ### ⚡ Performance - remove unnecessary clone in set_subcommand_ancestors by [@jdx](https://github.com/jdx) in [#448](#448) ### 🧪 Testing - add test coverage for untested modules by [@jdx](https://github.com/jdx) in [#447](#447) ### 🔍 Other Changes - remove commented-out trait implementations in mount.rs by [@jdx](https://github.com/jdx) in [#445](#445) - make codecov checks informational by [@jdx](https://github.com/jdx) in [#456](#456) ### 📦️ Dependency Updates - lock file maintenance by [@renovate[bot]](https://github.com/renovate[bot]) in [#439](#439) ### New Contributors - @ilyagr made their first contribution in [#460](#460)
Summary
Add CLAUDE.md file to provide context for Claude Code when working in this repository.
Contents:
Test plan
🤖 Generated with Claude Code
Note
Adds a contributor guidance doc for AI-assisted code workflows.
CLAUDE.mdwith project overview and goalscargo-insta)kdl,clap,miette,tera,insta)Written by Cursor Bugbot for commit 46db90c. This will update automatically on new commits. Configure here.