Skip to content

Add shared CLAUDE.md file#804

Merged
emmaaroche merged 1 commit intoKuadrant:mainfrom
emmaaroche:add-claude-md
Nov 11, 2025
Merged

Add shared CLAUDE.md file#804
emmaaroche merged 1 commit intoKuadrant:mainfrom
emmaaroche:add-claude-md

Conversation

@emmaaroche
Copy link
Copy Markdown
Contributor

Description

This PR adds a CLAUDE.md file to guide how Claude Code interacts with the testsuite.

The file was generated as an initial starting point by running the /init command in Claude Code from the repository root.

I’m opening this as a draft PR so we can review it as a team and discuss what to improve, remove, or add.

Closes #797

@zkraus
Copy link
Copy Markdown
Contributor

zkraus commented Oct 29, 2025

You probably seen it already, but just in case, linking a anthropic's best practices https://www.anthropic.com/engineering/claude-code-best-practices

generic thoughs
Just skimmed over the initial claude.md, and my first though, it seems a bit long. If I understand it correctly, it is supplied to the session, so it's length counts to overall token cost, Just an thought, maybe think of shortening it a bit. Like making points brief, or maybe thinking of unnecessary parts. On the other hand, think of emphasizing on MUST HAVEs

@emmaaroche
Copy link
Copy Markdown
Contributor Author

emmaaroche commented Nov 4, 2025

@zkraus agreed - the CLAUDE.md has been shortened (376 lines down to 120) and updated to align more closely with best practices, focusing more on the key information. I asked Claude to condense the initial file and then made a few small manual edits to it. It might still be worth making it even more concise, wdyt? 🤔

Would be great to get feedback from team to confirm if all relevant/necessary details are covered and to flag anything that might be unnecessary to keep.

Note: I’ll keep the commits separate for now so others can review the earlier version, and squash before merging when the time comes.

Comment thread CLAUDE.md Outdated
Comment thread CLAUDE.md
@emmaaroche emmaaroche requested a review from averevki November 5, 2025 17:25
@averevki
Copy link
Copy Markdown
Contributor

averevki commented Nov 5, 2025

Looks good 👍

@emmaaroche emmaaroche marked this pull request as ready for review November 6, 2025 09:29
@emmaaroche
Copy link
Copy Markdown
Contributor Author

Moved from draft to ready for review 👍

trepel
trepel previously approved these changes Nov 6, 2025
Copy link
Copy Markdown
Contributor

@trepel trepel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not experienced with what this documentation for AI should look like but it LGTM.

Signed-off-by: emmaaroche <eroche@redhat.com>
@emmaaroche emmaaroche merged commit f878796 into Kuadrant:main Nov 11, 2025
3 checks passed
@emmaaroche emmaaroche deleted the add-claude-md branch November 11, 2025 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create claude.md project context for the testsuite

5 participants