Skip to content

Commit a7f5ebd

Browse files
Add repository-wide AGENTS guidelines
1 parent 5dd57e4 commit a7f5ebd

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

AGENTS.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Arch Linux Without the Beeps — Agent Guide
2+
3+
## Scope
4+
These instructions apply to the entire repository unless a more specific `AGENTS.md` is added deeper in the tree.
5+
6+
## Workflow expectations
7+
- Keep the Docker-based build tooling working; avoid hard-coding host-specific paths or assumptions outside `/workdir`.
8+
- Prefer small, focused commits that touch only the files needed for a change.
9+
- When adding new automation scripts, place them under `scripts/` and document any new entry points in `README.md`.
10+
11+
## Coding guidelines
12+
- Python code should use 4-space indentation, descriptive function names, and avoid unnecessary try/except wrappers around imports.
13+
- Flask routes live in `app.py`; keep the streaming `/build` endpoint compatible with Server-Sent Events by yielding already-formatted `data:` lines.
14+
- HTML templates under `templates/` should remain dependency-free (plain Bootstrap/vanilla JS only) so that the GUI keeps working in the minimal container environment.
15+
16+
## Testing and verification
17+
- For Python changes, run `python -m compileall app.py` to catch syntax errors before opening a PR.
18+
- When touching Dockerfiles or build scripts, run `docker build -t arch-iso-builder .` (and the GUI variant with `-f Dockerfile.gui`) if the environment allows; otherwise explain the limitation in your summary.
19+
- Pure documentation or comment-only updates do not require a test run.

0 commit comments

Comments
 (0)