docs: add CLAUDE.md with project guidance#1047
Conversation
Add comprehensive project documentation for Claude Code including development setup, architecture overview, and common workflows. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lihongyan1 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
📝 WalkthroughWalkthroughA new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CLAUDE.md (1)
66-76: Clarify that TLS verification flags are for local development only.The workflow uses
--tls-verify=falseand--skip-tlsflags, which disable certificate verification. While appropriate for local Kind clusters, consider adding a note that these flags should never be used in production environments to prevent security misconfigurations if developers copy these commands.📝 Suggested clarification
# Build and push operator and bundle to local registry +# Note: --tls-verify=false and --skip-tls are for local development only make operator-image bundle-image operator-push bundle-push \ IMG_BASE="local-registry:30000/observability-operator" \ VERSION=0.0.0-dev \ PUSH_OPTIONS=--tls-verify=false🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CLAUDE.md` around lines 66 - 76, Add a short, explicit warning next to the build/push and run bundle commands clarifying that the flags PUSH_OPTIONS=--tls-verify=false and the operator-sdk --skip-tls option disable TLS/certificate verification and are intended for local development (e.g., Kind) only; update the CLAUDE.md section containing the make operator-image ... PUSH_OPTIONS and the ./tmp/bin/operator-sdk run bundle ... --skip-tls snippet to instruct developers to remove these flags or use proper TLS certificates in any non-local/production environment and to follow your cluster's certificate best practices.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@CLAUDE.md`:
- Around line 66-76: Add a short, explicit warning next to the build/push and
run bundle commands clarifying that the flags PUSH_OPTIONS=--tls-verify=false
and the operator-sdk --skip-tls option disable TLS/certificate verification and
are intended for local development (e.g., Kind) only; update the CLAUDE.md
section containing the make operator-image ... PUSH_OPTIONS and the
./tmp/bin/operator-sdk run bundle ... --skip-tls snippet to instruct developers
to remove these flags or use proper TLS certificates in any non-local/production
environment and to follow your cluster's certificate best practices.
1 participant
Add comprehensive project documentation for Claude Code including development setup, architecture overview, and common workflows.
Pulled this file before use claude, will save tokens