chore(docs): add AGENTS.md and Copilot review instructions#70
Conversation
Signed-off-by: Raghul-M <raghul.m1430@gmail.com>
|
🎉 Welcome to the Kubeflow MCP Server! 🎉 Thanks for opening your first PR! We're happy to have you as part of our community 🚀 Here's what happens next:
Join the community:
Feel free to ask questions in the comments if you need any help or clarification! |
There was a problem hiding this comment.
Pull request overview
Adds repository-specific guidance for AI contributors and automated reviews.
Changes:
- Documents architecture, tooling, testing, security, and contribution conventions.
- Configures Copilot review priorities and CI-aware exclusions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
AGENTS.md |
Adds AI contributor guidance and architecture conventions. |
.github/copilot-instructions.md |
Adds Copilot code-review guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: RAGHUL M <ragm@redhat.com>
|
/ok-to-test |
| ```bash | ||
| uv run pre-commit install | ||
| uv run pre-commit run --all-files | ||
| make inspector # MCP Inspector (stdio) |
There was a problem hiding this comment.
Nit: inspector isn’t stdio-only.
Signed-off-by: Raghul-M <raghul.m1430@gmail.com>
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abhijeet-dhumal 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 |
| make test-python # Unit tests + coverage | ||
| make test # Broader suite under tests/ and kubeflow_mcp/ |
|
|
||
| - **Style/formatting** — CI handles this (ruff / pre-commit) | ||
| - **Test failures** — CI handles this (pytest matrix) | ||
| - **Missing dependencies** — CI / lockfile checks handle this |
Description
Add AI contributor guidance for this repo, following the kubeflow/sdk pattern:
AGENTS.md— architecture (core/,trainer/, CLI), tool/persona conventions, confirm-gate rules, testing expectations, PR title/sign-off conventions, and what not to change without discussion.github/copilot-instructions.md— review priorities (security, correctness, patterns), what CI already covers, and when to stay silentRelated Issue
Fixes #58
Checklist
make test-python)make verify)git commit -s)Testing
Verified content against https://github.com/kubeflow/sdk/blob/main/AGENTS.md and https://github.com/kubeflow/sdk/blob/main/.github/copilot-instructions.md, adapted for kubeflow/mcp-server layout and CI.