Add CLAUDE.md documentation for AI-assisted development #1298
Conversation
Add comprehensive CLAUDE.md file to guide Claude Code and other AI assistants when working with the cluster-ingress-operator codebase. The documentation includes: - Build and test commands (unit, e2e, verification) - Development workflows (local, cluster deployment, remote builds) - Architecture overview (controllers, DNS providers, load balancers) - Key concepts (IngressController resources, test organization) - Common debugging commands This will help AI assistants be productive more quickly by understanding the repository structure, common patterns, and development practices. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
| ### Local Development (Recommended) | ||
|
|
||
| Run the operator locally without deploying to cluster: | ||
|
|
||
| ```bash | ||
| make run-local # Build and run operator from local machine | ||
| # Set ENABLE_CANARY=true to enable ingress canary during local runs | ||
| ``` | ||
|
|
||
| This scales down the cluster's operator and runs your local binary against the cluster. To restore cluster operator: | ||
|
|
||
| ```bash | ||
| oc scale --replicas 1 -n openshift-cluster-version deployments/cluster-version-operator |
There was a problem hiding this comment.
Since this is for claude to gain context regarding the repo for code generation assistance, would this be relevant information?
| ## Working with Gateway API | ||
|
|
||
| Gateway API support is experimental and requires Service Mesh operator: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
If we include links relating to gateway api either documentation or repos, would that be easier for the ai agent to index for more context and understanding?
|
Also I wanted to add Claude for reviewing in this repo, similar to what Joel did but I will wait for this PR to merge first |
|
This file and commit/comment are all generated by Claude and I didn't change anything, and the PR is opened by Claude as well. This is for experiment. Maybe after including more links relating to gateway api either documentation or repos, then ask Claude to regenerate the file and update the PR again ? |
|
@lihongan: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
Ah okay very cool. Yes! I've found giving claude a link to doc or even with a few links, it can index and understand better to create files that are more accurate |
2 participants
Summary
Details
This PR adds a CLAUDE.md file that provides:
The documentation focuses on non-obvious, repository-specific information that requires reading multiple files to understand, helping AI assistants be productive more quickly.
Test plan
🤖 Generated with Claude Code