chore(docs): Update Copilot Instructions and AGENTS.md#248
chore(docs): Update Copilot Instructions and AGENTS.md#248google-oss-prow[bot] merged 3 commits intokubeflow:mainfrom
Conversation
Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
Pull Request Test Coverage Report for Build 21383527272Details
💛 - Coveralls |
Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
e6d5804 to
defca46
Compare
There was a problem hiding this comment.
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
| │ ├── options/ # Backend configuration options (KubernetesOptions, etc.) | ||
| │ └── utils/ # Common utils |
There was a problem hiding this comment.
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/.
| │ ├── options/ # Backend configuration options (KubernetesOptions, etc.) | |
| │ └── utils/ # Common utils | |
| │ └── options/ # Backend configuration options (KubernetesOptions, etc.) |
.github/copilot-instructions.md
Outdated
|
|
||
| Do not comment on: | ||
|
|
||
| - **Style/formatting** - CI handles this (black, prettier) |
There was a problem hiding this comment.
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.
| - **Style/formatting** - CI handles this (black, prettier) | |
| - **Style/formatting** - CI handles this (ruff-check, ruff-format) |
Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
|
@kramaranya @astefanutti @Shekharrajak Please can you check this PR, so we get better reviews from Copilot like we have in Trainer? |
|
Thanks @andreyvelich! /lgtm |
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
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