Daan De Meyer
e2cfdfff15
It's easier to run the AI tool within mkosi box rather than telling it to use mkosi box and forgetting to use it half the time.
44 lines
1.9 KiB
Markdown
44 lines
1.9 KiB
Markdown
# AGENTS.md
|
|
|
|
This file provides guidance to AI coding agents when working with code in this repository. Only add
|
|
instructions to this file if you've seen an AI agent mess up that particular bit of logic in practice.
|
|
|
|
## Key Documentation
|
|
|
|
Always consult these files as needed:
|
|
|
|
- `docs/ARCHITECTURE.md` — code organization and component relationships
|
|
- `docs/HACKING.md` — development workflow with mkosi
|
|
- `docs/CODING_STYLE.md` — full style guide (must-read before writing code)
|
|
- `docs/CONTRIBUTING.md` — contribution guidelines and PR workflow
|
|
|
|
## Running arbitrary commands
|
|
|
|
- Never use `mkosi box` to wrap commands. You are either already running inside an mkosi box environment or
|
|
running outside of it — use the tools available in your current environment directly.
|
|
|
|
## Build and Test Commands
|
|
|
|
- Never compile individual files. Always run `meson compile -C build <target>` to build the target you're
|
|
working on. Meson handles incremental compilation automatically.
|
|
- Never run `meson compile` followed by `meson test` as separate steps. Always run
|
|
`meson test -C build -v <TEST-NAME>` directly. Meson will automatically rebuild any required targets before
|
|
running tests.
|
|
- Never invent your own build commands or try to optimize the build process.
|
|
- Never use `head`, `tail`, or pipe (`|`) the output of build or test commands. Always let the full output
|
|
display. This is critical for diagnosing build and test failures.
|
|
|
|
## Integration Tests
|
|
|
|
- Never use `grep -q` in pipelines; use `grep >/dev/null` instead (avoids `SIGPIPE`)
|
|
|
|
## Pull Request Review Instructions
|
|
|
|
- Always check out the PR in a git worktree in `worktrees/`, review it locally and remove the worktree when finished.
|
|
|
|
## AI Contribution Disclosure
|
|
|
|
Per project policy: if you use AI code generation tools, you **must disclose** this in commit messages
|
|
by adding e.g. `Co-developed-by: Claude Opus 4.6 <noreply@anthropic.com>`.
|
|
All AI-generated output requires thorough human review before submission.
|