55 lines
2.0 KiB
Markdown
55 lines
2.0 KiB
Markdown
# Agent Instructions
|
|
|
|
Key non-negotiable rules from that file:
|
|
|
|
- **Always present a plan first** and wait for user approval before making any changes — no matter how small the task.
|
|
- Never commit or create branches unless explicitly asked.
|
|
|
|
# Agent Guidelines — nixos-setup
|
|
|
|
Rules and best practices for any AI agent working in this repository.
|
|
Read this file before making any changes.
|
|
|
|
---
|
|
|
|
## 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 — Never Break These
|
|
|
|
**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 these. Your role is to write good Nix, not execute it.
|
|
|
|
### ❌ NEVER modify `GUIDELINES.md` unless explicitly requested by the user
|
|
|
|
You must **live and die by these rules** and hold yourself accountable to them.
|
|
These are not suggestions — they are non-negotiable.
|
|
|
|
### KEEP EVERYTHING CONCISE, shorter concise comments are preferable, less jargon and more common words.
|
|
|
|
## When In Doubt
|
|
|
|
If you are unsure whether a command is safe, **assume it is NOT SAFE and don't run it.**
|
|
|
|
Instead: 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
|
|
- Do NOT `git add`, `git commit`, or `git push` autonomously
|
|
- You may run `git add` **only** if required for a Nix evaluation (e.g., new files must be tracked for flakes)
|
|
- Describe what you changed in your final message so the user can review before committing
|