41 lines
1.6 KiB
Markdown
41 lines
1.6 KiB
Markdown
# Agent Instructions
|
|
|
|
Read this file before making any changes.
|
|
|
|
`CLAUDE.md` and `.agents/AGENTS.md` are symlinks to this file. Do not treat them as separate copies.
|
|
|
|
## Mandatory First Step — Always Present a Plan
|
|
|
|
Before making **any** change to this repository, you MUST present a short plan to the user and wait for their approval. This applies to every task, no matter how small.
|
|
|
|
Your plan must include:
|
|
|
|
1. **What** you intend to change (files, options, packages)
|
|
2. **Why** the change is needed
|
|
3. **How** you will do it (which files you will edit, in what order)
|
|
4. **What you will NOT do** (e.g., "I will not run any builds")
|
|
|
|
Only after the user approves the plan may you proceed with edits.
|
|
|
|
## Hard Rules
|
|
|
|
**Your job:** Make correct edits to source files. The user validates and runs builds themselves.
|
|
|
|
**Even if the user says "go ahead":** Do NOT run builds, evals, or similar commands.
|
|
|
|
- Keep comments short and plain. Prefer common words over jargon.
|
|
- Minimize the use of `var` in type definitions. Always prefer explicit types where possible.
|
|
- When setting up a new type via `QtObject`, avoid providing defaults unless there is a good reason.
|
|
|
|
## When In Doubt
|
|
|
|
If you are unsure whether a command is safe, assume it is **not** and don't run it.
|
|
|
|
Describe what you would do and ask the user for permission.
|
|
|
|
## Commit / Branch / Git Policy
|
|
|
|
- Do not commit changes or create branches unless the user explicitly asks. Instead just don't do it.
|
|
- Do not `git add`, `git commit`, or `git push` autonomously. Instead just don't ever do it.
|
|
- Describe what you changed in your final message so the user can review before committing
|