Skip to content

Add CLAUDE.md documentation #880

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.

Sign up for GitHub

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

Jump to bottom
Open
jhjaggars wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add CLAUDE.md documentation #880

jhjaggars wants to merge 2 commits into from

Conversation

@jhjaggars
Copy link

@jhjaggars jhjaggars commented Sep 18, 2025

This PR adds CLAUDE.md documentation to help with AI-assisted development.

Generated using Claude Code automation.

@jhjaggars
Add CLAUDE.md documentation
175a681 
Generated using Claude Code automation to enhance AI-assisted development capabilities.
@openshift-ci
Copy link

openshift-ci bot commented Sep 18, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jhjaggars
Once this PR has been reviewed and has the lgtm label, please assign jgbernalp for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci
Copy link

openshift-ci bot commented Sep 18, 2025

Hi @jhjaggars. Thanks for your PR.

I'm waiting for a rhobs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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.

jan--f
jan--f reviewed Sep 23, 2025
View reviewed changes
jan--f
jan--f reviewed Sep 23, 2025
View reviewed changes
jan--f
jan--f reviewed Sep 23, 2025
View reviewed changes
@jhjaggars @claude
Fix CLAUDE.md based on reviewer feedback
3ae2372 
Address PR review comments:
- Replace abstract "go run" instruction with complete 5-step process
- Add exact commands for building, deploying, and running operator locally
- Remove hardcoded controller-runtime version (v0.21.0)
- Clarify that OLM is commonly used but not strictly required
- Include proper kubeconfig flag and output redirection in go run command

The original single-line go run command failed without prerequisites.
Now provides copy-pasteable commands that actually work.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jan--f jan--f jan--f left review comments

@lihongyan1 lihongyan1 Awaiting requested review from lihongyan1

@slashpai slashpai Awaiting requested review from slashpai

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

needs-ok-to-test

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jhjaggars @jan--f