Add AGENTS.md with project instructions for AI coding agents#232
Add AGENTS.md with project instructions for AI coding agents#232zeitlinger merged 2 commits intomainfrom
Conversation
AGENTS.md is the open standard (Linux Foundation / Agentic AI Foundation) supported by multiple AI coding tools. CLAUDE.md imports it via @AGENTS.md. Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
zeitlinger
requested review from
a team,
grcevski and
rlankfo
as code owners
There was a problem hiding this comment.
Pull request overview
This pull request adds documentation for AI coding agents following the Linux Foundation / Agentic AI Foundation open standard. The files provide comprehensive project guidance covering build commands, architecture, code conventions, linting, and testing practices.
Changes:
- Add AGENTS.md with detailed project instructions for AI coding agents
- Add CLAUDE.md that imports AGENTS.md using the
@AGENTS.mdsyntax
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AGENTS.md | Comprehensive documentation covering project overview, build commands, linting, architecture, CLI usage, code conventions, testing, and CI |
| CLAUDE.md | Simple import file that references AGENTS.md for Claude-specific tooling |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Run end-to-end tests | ||
| mise run e2e-test | ||
|
|
There was a problem hiding this comment.
The mise run e2e-test command is referenced in the CI workflow (.github/workflows/e2e_test.yml:18) but does not exist as a defined task in mise.toml. This command will fail if someone tries to run it based on these instructions.
| # Run end-to-end tests | |
| mise run e2e-test |
There was a problem hiding this comment.
The e2e-test task does exist — it's defined as a shell script in .mise/tasks/e2e-test.sh. Mise auto-discovers tasks from both mise.toml and the .mise/tasks/ directory. I've added a note to clarify this for future readers.
- Fix prettier formatting in AGENTS.md - Add markdownlint-disable for CLAUDE.md import directive Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
|
Thanks @Copilot — addressed 2 comment(s). Please have another look! |
Summary
@AGENTS.mdTest plan