Refine CLAUDE/AGENTS.md

[mhamza15]

Description

Refines CLAUDE/AGENTS.md with more targeted instructions for working in the Vitess repo. More suggestions welcome!

Related Issue(s)

Checklist

• "Backport to:" labels have been added if this change should be back-ported to release branches
• If this change is to be back-ported to previous releases, a justification is included in the PR description
• Tests were added or are not required
• Did the new or modified tests pass consistently locally and on CI?
• Documentation was added or is not required

Deployment Notes

AI Disclosure

Help from GPT 5.2 Codex.

[vitess-bot]

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

• Ensure that the Pull Request has a descriptive title.
• Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

• Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

• Apply the release notes (needs details) label if users need to know about this change.
• New features should be documented.
• There should be some code comments as to why things are implemented the way they are.
• There should be a comment at the top of each new or modified test to explain what the test does.

New flags

• Is this flag really necessary?
• Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

• Each item in Jobs should be named in order to mark it as required.
• If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

• Protobuf changes should be wire-compatible.
• Changes to _vt tables and RPCs need to be backward compatible.
• RPC changes should be compatible with vitess-operator
• If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
• vtctl command output order should be stable and awk-able.

[mattlord]

The things that were added certainly seem fine. But I don't know why we removed the other stuff, nor do I know how we can try to objectively measure whether or not the new one or any particular change results in practical improvements or not. Do you?

[mhamza15]

The things that were added certainly seem fine. But I don't know why we removed the other stuff, nor do I know how we can try to objectively measure whether or not the new one or any particular change results in practical improvements or not. Do you?

The approach I took was to try to focus the file on things specific to developing Vitess, and try to avoid approaches that might be unique to the developer's own workflow or style. That way things that individual contributors might prefer can go into their own global/local AGENTS.md file.

Having said that, I used my judgement to discern what was relevant to everyone and what might be more dependent on the individual. That judgment can certainly be off, so I'm very open for you and other reviewers to tell me "Hey this section seems useful, let's keep it around." So please let me know if you found value in anything removed!

In terms of measure how useful they are, I don't have a good answer other than "vibes" 😅. There's always room to iterate if we find agents missing key behaviors or patterns, or are too aggressive in following something mentioned.

[arthurschreiber]

Things we might want to add:

• Recompile binaries before running end-to-end test cases.
• Use NOVTADMINBUILD=1 when running make build if we're not touching vtadmin.
• Run go test with -count=1 to sidestep test caching.
• Clear out the vtdataroot directory between test runs.

[mhamza15]

Things we might want to add:

• Recompile binaries before running end-to-end test cases.
• Use NOVTADMINBUILD=1 when running make build if we're not touching vtadmin.
• Run go test with -count=1 to sidestep test caching.
• Clear out the vtdataroot directory between test runs.

Done in 3dc896b!

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.91%. Comparing base (d38ee62) to head (3dc896b).
⚠️ Report is 16 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff            @@
##             main   #19170    +/-   ##
========================================
  Coverage   69.90%   69.91%            
========================================
  Files        1613     1611     -2     
  Lines      216076   216178   +102     
========================================
+ Hits       151055   151146    +91     
- Misses      65021    65032    +11     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.