Skip to content

chore(ai): add AGENTS.md to improve assisted contributions#3459

Open
abramche wants to merge 1 commit into
scylladb:masterfrom
abramche:chore/add-agents-md
Open

chore(ai): add AGENTS.md to improve assisted contributions#3459
abramche wants to merge 1 commit into
scylladb:masterfrom
abramche:chore/add-agents-md

Conversation

@abramche

@abramche abramche commented May 28, 2026

Copy link
Copy Markdown
Contributor

Description of your changes:
Add AGENTS.md to guide AI-assisted contributions towards team standards and conventions

Which issue is resolved by this Pull Request:
Resolves https://scylladb.atlassian.net/browse/OPERATOR-132

@scylla-operator-bot

scylla-operator-bot Bot commented May 28, 2026

Copy link
Copy Markdown
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@scylla-operator-bot scylla-operator-bot Bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 28, 2026
@github-actions github-actions Bot added the P2 label May 28, 2026
@abramche

abramche commented May 28, 2026

Copy link
Copy Markdown
Contributor Author

/kind machinery
/priority important-soon

@scylla-operator-bot scylla-operator-bot Bot added kind/machinery Categorizes issue or PR as related to Makefile, scripts or similar changes. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels May 28, 2026
@abramche abramche force-pushed the chore/add-agents-md branch 2 times, most recently from e01922c to 0d010ff Compare May 29, 2026 09:59
@abramche abramche marked this pull request as ready for review June 2, 2026 15:54
@scylla-operator-bot scylla-operator-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 2, 2026
@scylla-operator-bot scylla-operator-bot Bot requested a review from czeslavo June 2, 2026 15:54
rzetelskik
rzetelskik reviewed Jun 2, 2026
View reviewed changes
Comment thread AGENTS.md
@abramche abramche force-pushed the chore/add-agents-md branch from 0d010ff to 3e68da8 Compare June 3, 2026 09:18
@scylla-operator-bot scylla-operator-bot Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 3, 2026
rzetelskik
rzetelskik reviewed Jun 3, 2026
View reviewed changes
Comment thread .github/copilot-instructions.md
@rzetelskik rzetelskik requested a review from Copilot June 3, 2026 10:11
Copilot AI reviewed Jun 3, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR introduces a central, repo-root AGENTS.md intended to guide AI-assisted contributions toward ScyllaDB Operator’s established contribution and API conventions, and updates other agent-entrypoint instruction files to reference it.

Changes:

  • Added AGENTS.md with high-level project context and links to key contribution/design docs.
  • Added CLAUDE.md to direct Claude-based tooling to AGENTS.md.
  • Simplified .github/copilot-instructions.md to delegate guidance to AGENTS.md.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
CLAUDE.md New entrypoint instructions for Claude-based agents pointing to AGENTS.md.
AGENTS.md New central instructions file for AI coding agents, linking to core project conventions.
.github/copilot-instructions.md Replaces embedded rules with a pointer to AGENTS.md as the canonical guidance.

Comment thread CLAUDE.md Outdated
Comment thread AGENTS.md
@abramche abramche force-pushed the chore/add-agents-md branch 3 times, most recently from d12a001 to e97e7f5 Compare June 3, 2026 17:42
@abramche

abramche commented Jun 3, 2026

Copy link
Copy Markdown
Contributor Author

rebased on master - the build passes

czeslavo
czeslavo reviewed Jun 9, 2026
View reviewed changes

@czeslavo czeslavo 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.

lgtm

/assign @rzetelskik

@rzetelskik

rzetelskik commented Jun 9, 2026

Copy link
Copy Markdown
Member

@mflendrich iirc you wanted to discuss this on a team meeting, so I'm assigning to you
/assign @mflendrich

@rzetelskik rzetelskik removed their assignment Jun 9, 2026
rzetelskik
rzetelskik reviewed Jun 9, 2026
View reviewed changes

@rzetelskik rzetelskik left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One more nit, opinionated so feel free to ignore.
Leaving the final approval for Michal.

Comment thread AGENTS.md Outdated
Comment on lines +5 to +7
## Project Overview

scylla-operator is a Kubernetes operator for managing ScyllaDB clusters, written in Go using controller-runtime patterns.

@rzetelskik rzetelskik Jun 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: I'm sure this can be easily understood by the agent by just reading the readme and code, so I personally don't see how this could improve the agent's workflow or output, but I don't feel strong about removing it, so leaving as a nit

@abramche abramche Jun 10, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm ok with removing it. It would just increase the context window and decrease probability of agents picking up linked changed.

addressed in fddbdbc

@abramche abramche force-pushed the chore/add-agents-md branch from e97e7f5 to fddbdbc Compare June 10, 2026 11:55
@scylla-operator-bot

scylla-operator-bot Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: abramche
Once this PR has been reviewed and has the lgtm label, please ask for approval from mflendrich. 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@czeslavo czeslavo czeslavo left review comments
@rzetelskik rzetelskik rzetelskik left review comments
Copilot code review Copilot Copilot left review comments

Assignees

@mflendrich mflendrich

Labels

kind/machinery Categorizes issue or PR as related to Makefile, scripts or similar changes. P2 priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@abramche @rzetelskik @czeslavo @mflendrich