-
Notifications
You must be signed in to change notification settings - Fork 19
Open
Description
Description
To improve the effectiveness of AI agents working on this repository, we should add an AGENTS.md file in the root directory. This file will serve as a definitive guide for AI agents (and human contributors), providing context, code standards, and standard commands for development and testing.
We should take inspiration from other Kubeflow repositories that have successfully implemented this, such as trainer, pipelines, and sdk.
Goal
Create an AGENTS.md file that includes the following sections:
- Who This Is For: Clarify the audience (AI agents, contributors, maintainers).
- Agent Behavior Policy: Define rules for AI agents (e.g., atomic changes, running verification before committing, not modifying CI without instruction).
- Repository Map: A high-level tree structure of the
docs-agentrepository explaining the purpose of key directories (server,server-https,pipelines,manifests, etc.). - Environment & Tooling:
- Primary languages (Python).
- Key dependencies (Milvus, KServe, Kubeflow Pipelines).
- Development tools (Helm, kubectl, etc.).
- Commands:
- Standard commands for setup, running servers, and testing.
- Note: Since this repo currently lacks a
Makefile, we might want to standardize some of these commands or explicitly list thepythonandhelmcommands found inREADME.md.
- Development Workflow:
- Preferred workflows for making changes.
- Commit message conventions.
- Core Development Principles:
- Code quality standards (Python style, typing).
- Documentation requirements.
Reference Examples
Tasks
- Create
AGENTS.mdin the root directory. - Populate it with the sections outlined above, tailored to the
docs-agentspecifics (RAG, Milvus, KServe context). - (Optional) Create a
Makefileto standardize commands referenced inAGENTS.md, aligning with other Kubeflow repos.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels