feat(docs): Add AGENTS.md and Copilot instructions by andreyvelich · Pull Request #3121 · kubeflow/trainer

andreyvelich · 2026-01-24T00:27:31Z

I added the AGENTS.md and Copilot instructions to make our code review more useful.

Copilot instructions are mostly inspired by the Goose project, let's see if that will help us.

/cc @astefanutti @kramaranya @tenzen-y @franciscojavierarceo @akshaychitneni @jaiakash @Electronic-Waste @osamaahmed17

google-oss-prow · 2026-01-24T00:27:41Z

@andreyvelich: GitHub didn't allow me to request PR reviews from the following users: osamaahmed17.

Note that only kubeflow members and repo collaborators can review this PR, and authors cannot review their own PRs.

Details

In response to this:

I added the AGENTS.md and Copilot instructions to make our code review more useful.

Copilot instructions are mostly inspired by the Goose project, let's see if that will help us.

/cc @astefanutti @kramaranya @tenzen-y @franciscojavierarceo @akshaychitneni @jaiakash @Electronic-Waste @osamaahmed17

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/test-infra repository.

Copilot

Pull request overview

This PR introduces documentation to guide AI agents and improve code review effectiveness. It establishes development conventions, repository structure, and review guidelines for both automated tools and human contributors.

Changes:

Added comprehensive agent guidelines covering behavior policies, development workflow, and coding standards
Added Copilot-specific review instructions to focus on high-confidence, actionable feedback
Documented repository structure, tooling, and testing requirements across Go, Python, and Rust

Reviewed changes

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

File	Description
AGENTS.md	Provides comprehensive guidelines for AI agents and contributors, including repository structure, development workflow, and language-specific coding standards
.github/copilot-instructions.md	Defines code review philosophy and priorities for GitHub Copilot to ensure focused, high-confidence feedback

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-24T00:27:56Z

AGENTS.md

+Agents must NOT:
+
+- Bypass tests or linters
+- Introduce dependencies without updating `go.mod` (Go) or `pyproject.toml` (Python) or `cargo.toml` (Rust)


Corrected filename 'cargo.toml' to 'Cargo.toml' - Rust uses capitalized Cargo.toml as the standard manifest filename.

Suggested change

- Introduce dependencies without updating `go.mod` (Go) or `pyproject.toml` (Python) or `cargo.toml` (Rust)

- Introduce dependencies without updating `go.mod` (Go) or `pyproject.toml` (Python) or `Cargo.toml` (Rust)

Copilot · 2026-01-24T00:27:57Z

AGENTS.md

+
+- File names must have `*_test.go` postfix
+- Use dictionary to define test cases
+- Test functions must have the same name as


Incomplete sentence - appears to be cut off mid-thought. Should specify what test functions must have the same name as (likely 'the function being tested').

Suggested change

- Test functions must have the same name as

- Test functions must have the same name as the function being tested, prefixed with `Test`

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

coveralls · 2026-01-24T00:32:12Z

Pull Request Test Coverage Report for Build 21365977695

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 51.131%

Totals
Change from base Build 21288221172:	0.0%
Covered Lines:	1243
Relevant Lines:	2431

💛 - Coveralls

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

osamaahmed17 · 2026-01-24T13:58:30Z

@andreyvelich: GitHub didn't allow me to request PR reviews from the following users: osamaahmed17.

Note that only kubeflow members and repo collaborators can review this PR, and authors cannot review their own PRs.

Details

@andreyvelich , is it possible for you to add me as a Kubeflow member?

google-oss-prow · 2026-01-24T13:58:49Z

@osamaahmed17: changing LGTM is restricted to collaborators

Details

In response to this:

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/test-infra repository.

andreyvelich · 2026-01-25T19:27:46Z

@andreyvelich , is it possible for you to add me as a Kubeflow member?

@osamaahmed17 Sure, please create PR to add yourself to the Kubeflow org: https://github.com/kubeflow/internal-acls
I am happy to sponsor it.

akshaychitneni · 2026-01-26T02:31:17Z

AGENTS.md

+AI agents should:
+
+- Make atomic, minimal, and reversible changes.
+- Prefer local analysis (e.g. `make generate`, `make fmt`, `make test`, `make test-python`) before proposing commits.


Should we mention about scanning for vulnerabilities in the generated code or dependencies introduced?

akshaychitneni · 2026-01-26T02:34:51Z

.github/copilot-instructions.md

+
+- Code that violates existing patterns in the codebase
+- Missing error handling
+- Code that is not following [Effective Go](https://go.dev/doc/effective_go) best practices


Should mention about python, rust as well

akshaychitneni · 2026-01-26T02:36:45Z

AGENTS.md

+- Match import patterns from neighboring files
+- Preserve existing logging and error-handling conventions
+- Understand the plugin architecture and extension framework before modifying runtime code
+- Review CRD schemas in `pkg/apis/` before changing API structures


call out breaking api changes wherever required

akshaychitneni · 2026-01-26T02:56:58Z

AGENTS.md

+
+- **CRD schemas** (`pkg/apis/trainer/v1alpha1`): Changes require careful review
+  - Adding fields: Use `+optional` marker and provide defaults
+  - Removing/renaming fields: Requires API version bump and migration plan


Should mention using CEL validation whenever applicable - https://kubernetes.io/docs/reference/using-api/cel/

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

andreyvelich · 2026-01-26T16:45:36Z

Thanks for review @akshaychitneni!
Updated the docs.

jaiakash

Looks good to me.

andreyvelich

/approve
/assign @akshaychitneni @akshaychitneni @osamaahmed17 @franciscojavierarceo

google-oss-prow · 2026-01-26T17:37:53Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andreyvelich

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [andreyvelich]

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

Copilot AI review requested due to automatic review settings January 24, 2026 00:27

google-oss-prow bot requested review from Electronic-Waste, akshaychitneni, astefanutti, franciscojavierarceo, jaiakash, kramaranya and tenzen-y January 24, 2026 00:27

google-oss-prow bot added the size/L label Jan 24, 2026

Copilot AI reviewed Jan 24, 2026

View reviewed changes

feat(docs): Add AGENTS.md and Copilot instructions

a963f3d

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

andreyvelich force-pushed the agents-md branch from ee5b36e to a963f3d Compare January 24, 2026 00:29

Fix Rust package name

fa31305

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

osamaahmed17 approved these changes Jan 24, 2026

View reviewed changes

andreyvelich mentioned this pull request Jan 25, 2026

chore(trainer): add trainerclient and optimizerclient sections kubeflow/sdk#190

Closed

akshaychitneni reviewed Jan 26, 2026

View reviewed changes

andreyvelich added 2 commits January 26, 2026 16:40

Info about CVEs and Python, Rust best practices

2b6869c

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

Deprecation info and CEL validation

2bbd7a1

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

jaiakash reviewed Jan 26, 2026

View reviewed changes

andreyvelich commented Jan 26, 2026

View reviewed changes

google-oss-prow bot assigned akshaychitneni Jan 26, 2026

google-oss-prow bot assigned osamaahmed17 Jan 26, 2026

google-oss-prow bot added the approved label Jan 26, 2026

akshaychitneni approved these changes Jan 26, 2026

View reviewed changes

google-oss-prow bot added the lgtm label Jan 26, 2026

google-oss-prow bot merged commit e0e033f into kubeflow:master Jan 26, 2026
33 checks passed

google-oss-prow bot added this to the v2.2 milestone Jan 26, 2026

andreyvelich deleted the agents-md branch January 26, 2026 18:46

andreyvelich mentioned this pull request Jan 27, 2026

chore(docs): Update Copilot Instructions and AGENTS.md kubeflow/sdk#248

Merged

	- Introduce dependencies without updating `go.mod` (Go) or `pyproject.toml` (Python) or `cargo.toml` (Rust)
	- Introduce dependencies without updating `go.mod` (Go) or `pyproject.toml` (Python) or `Cargo.toml` (Rust)

	- Test functions must have the same name as
	- Test functions must have the same name as the function being tested, prefixed with `Test`

Conversation

andreyvelich commented Jan 24, 2026

Uh oh!

google-oss-prow bot commented Jan 24, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

coveralls commented Jan 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 21365977695

Details

💛 - Coveralls

Uh oh!

osamaahmed17 commented Jan 24, 2026

Uh oh!

google-oss-prow bot commented Jan 24, 2026

Uh oh!

andreyvelich commented Jan 25, 2026

Uh oh!

akshaychitneni Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

akshaychitneni Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

akshaychitneni Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

akshaychitneni Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

andreyvelich commented Jan 26, 2026

Uh oh!

jaiakash left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andreyvelich left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

google-oss-prow bot commented Jan 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

coveralls commented Jan 24, 2026 •

edited

Loading

jaiakash left a comment •

edited

Loading

andreyvelich left a comment •

edited

Loading