Skip to content

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

Merged
google-oss-prow[bot] merged 3 commits intokubeflow:mainfrom
andreyvelich:copilot-review
Feb 3, 2026
Merged

chore(docs): Update Copilot Instructions and AGENTS.md#248
google-oss-prow[bot] merged 3 commits intokubeflow:mainfrom
andreyvelich:copilot-review

Conversation

@andreyvelich
Copy link
Copy Markdown
Member

Update Copilot instructions similar to Trainer: kubeflow/trainer#3121

Also, I updated AGENTS.md to make the context clearer.
Fixes: #190
Fixes: #189

cc @kubeflow/kubeflow-sdk-team

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
Copilot AI review requested due to automatic review settings January 27, 2026 03:27
@coveralls
Copy link
Copy Markdown

coveralls commented Jan 27, 2026

Pull Request Test Coverage Report for Build 21383527272

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 67.52%

Totals Coverage Status
Change from base Build 21379335186: 0.0%
Covered Lines: 2769
Relevant Lines: 4101

💛 - Coveralls

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 updates the Copilot instructions and AGENTS.md documentation to provide clearer context for AI agents and contributors. The changes streamline the documentation by removing verbose examples and sections while adding a more detailed repository map that includes the optimizer and hub components.

Changes:

  • Added comprehensive repository map showing the structure of trainer, optimizer, and hub components
  • Replaced simple Copilot instructions with detailed code review guidelines and philosophy
  • Removed extensive test examples and architectural improvement sections to make the documentation more concise

Reviewed changes

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

File Description
AGENTS.md Expanded repository map to include detailed structure of trainer, optimizer, and hub components; removed verbose examples and checklists to streamline the documentation
.github/copilot-instructions.md Replaced minimal instructions with comprehensive code review guidelines including review philosophy, priority areas, CI context, and response format guidance

AGENTS.md Outdated
Comment on lines +51 to +52
│ ├── options/ # Backend configuration options (KubernetesOptions, etc.)
│ └── utils/ # Common utils
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

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

The repository map lists "utils/" as a directory under kubeflow/trainer/, but this directory does not exist in the actual codebase. The trainer module contains api/, backends/, constants/, options/, test/, and types/ directories, but no standalone utils/ directory. Utils modules exist within individual backend subdirectories (e.g., kubeflow/trainer/backends/kubernetes/utils.py), but there is no top-level utils/ directory under trainer/.

Suggested change
│ ├── options/ # Backend configuration options (KubernetesOptions, etc.)
│ └── utils/ # Common utils
│ └── options/ # Backend configuration options (KubernetesOptions, etc.)

Copilot uses AI. Check for mistakes.

Do not comment on:

- **Style/formatting** - CI handles this (black, prettier)
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

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

The documentation mentions "black, prettier" as the formatters, but the project actually uses ruff for both linting and formatting. According to pyproject.toml line 63 and .pre-commit-config.yaml lines 14-17, the project uses ruff-check and ruff-format, not black or prettier. This should be updated to accurately reflect the tools used in this codebase.

Suggested change
- **Style/formatting** - CI handles this (black, prettier)
- **Style/formatting** - CI handles this (ruff-check, ruff-format)

Copilot uses AI. Check for mistakes.
Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
@andreyvelich
Copy link
Copy Markdown
Member Author

@kramaranya @astefanutti @Shekharrajak Please can you check this PR, so we get better reviews from Copilot like we have in Trainer?

@astefanutti
Copy link
Copy Markdown
Contributor

Thanks @andreyvelich!

/lgtm
/approve

@google-oss-prow
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: astefanutti

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:

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

@google-oss-prow google-oss-prow bot merged commit e4a2be8 into kubeflow:main Feb 3, 2026
13 of 14 checks passed
@google-oss-prow google-oss-prow bot added this to the v0.4 milestone Feb 3, 2026
@andreyvelich andreyvelich deleted the copilot-review branch February 3, 2026 16:56
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.

Update AGENTS.md with OptimizerClient and new features

4 participants