Skip to content

simplify claude/agents.md - #20873

Open
mhamza15 wants to merge 1 commit into
mainfrom
agentsmd
Open

simplify claude/agents.md#20873
mhamza15 wants to merge 1 commit into
mainfrom
agentsmd

Conversation

@mhamza15

@mhamza15 mhamza15 commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Description

Simplify CLAUDE.md/AGENTS.md. The initial documents were created in a time where agents needed much more hand-holding. This reduces it to only the Vitess-project-specific guidelines. If there is something missing that you'd prefer to keep, please bring it up, or alternatively consider adding it to your personal CLAUDE.md/AGENTS.md.

Related Issue(s)

N/A

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

N/A

AI Disclosure

Help from gpt-5.6-sol.

Signed-off-by: Mohamed Hamza <mhamza@fastmail.com>
Copilot AI balanced review requested due to automatic review settings August 19, 2026 13:37
@mhamza15 mhamza15 self-assigned this Aug 19, 2026
@mhamza15
mhamza15 marked this pull request as ready for review August 19, 2026 13:37
@github-actions github-actions Bot added this to the v25.0.0 milestone Aug 19, 2026
@vitess-bot vitess-bot Bot added NeedsWebsiteDocsUpdate What it says NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Aug 19, 2026
@vitess-bot

vitess-bot Bot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Simplifies repository-wide AI agent guidance to retain concise Vitess-specific requirements.

Changes:

  • Condenses testing and error-handling guidance.
  • Retains release compatibility, formatting, and PR template requirements.
  • Removes generic workflow and design advice.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@mhamza15 mhamza15 added Type: Documentation Component: Documentation docs related issues/PRs and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Aug 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants