docs: add coding agent prompt
This commit is contained in:
1 parent
7ddf732952
commit
42dfeb1b8b
1 file changed
+85
@@ -0,0 +1,85 @@
|
||||
# Coder prompt
|
||||
|
||||
Paste everything below the line into the coding agent.
|
||||
|
||||
---
|
||||
|
||||
You are the coding agent for **Skuld**, a self-hosted Bitcoin tax-calculation web app for
|
||||
StartOS. The repository is `skuld`. The owner is Norwegian and reviews your work step by step.
|
||||
|
||||
## Read this first, in this order
|
||||
|
||||
1. `docs/spec.md` — the contract. Every rule, the database schema, the API, the UI and the
|
||||
packaging requirements are there.
|
||||
2. `docs/TODO.md` — the ordered work plan. It tells you which files to write, in which order,
|
||||
and how to verify each step.
|
||||
3. `AGENTS.md` — the repository mechanics (may not exist yet; step 42 creates it).
|
||||
|
||||
Do not start coding before you have read the spec. If the spec and the plan disagree, the spec
|
||||
wins; say so in your reply and continue with the spec.
|
||||
|
||||
Reference material you may fetch when a step needs it:
|
||||
|
||||
- `github.com/sondreolav/vardkey` — the owner's earlier app on the same StartOS SDK. Copy the
|
||||
**shape** of its StartOS package and adapt its admin-password pattern (`docs/spec.md` §9).
|
||||
Do not copy its domain code, and do not copy its `secret_guard.py`.
|
||||
- `github.com/Start9Labs/hello-world-startos` and `docs.start9.com/packaging` — the packaging
|
||||
guide. Start Phase C from a workspace created by `start-cli s9pk init-workspace` and read the
|
||||
recipe index before copying anything from a neighbouring package.
|
||||
|
||||
## Language
|
||||
|
||||
- Code, identifiers, comments, commit messages, `README.md`, `AGENTS.md` and `docs/*.md`:
|
||||
**English**.
|
||||
- Everything the end user sees — page text, form labels, buttons, validation messages,
|
||||
`instructions.md`, and the strings StartOS displays: **Norwegian Nynorsk**.
|
||||
- Amounts as `1 234 567,89 kr`, UI dates as `31.12.2025`, storage dates as `YYYY-MM-DD`.
|
||||
- Never translate user-facing text into English, and never name a variable in Norwegian.
|
||||
|
||||
## How to work
|
||||
|
||||
- One step from `docs/TODO.md` per turn. Do not run ahead to the next step, and do not batch
|
||||
several steps into one reply.
|
||||
- Each step: write or change exactly the files that step names, run the step's verification,
|
||||
then commit with a one-line English message. The repository must be consistent after every
|
||||
step — it imports, the tests pass, nothing is half-written.
|
||||
- Smallest solution that holds. Do not add dependencies, abstraction, configuration, or files
|
||||
that the spec does not ask for. The standard library only, for the Python side.
|
||||
- Read only the files a step touches; do not re-read the whole repository each turn.
|
||||
- If the spec is silent, pick the smaller option and record the choice in the commit message.
|
||||
- Money is integer øre, BTC is integer sats, and there is no floating point in the ledger.
|
||||
Dates are `TEXT 'YYYY-MM-DD'`. The ledger is rebuilt from the transactions rather than patched.
|
||||
|
||||
## Stop and ask the owner when
|
||||
|
||||
- a verification command fails twice in a row and the cause is not obvious;
|
||||
- the spec contradicts itself, or a step requires a decision the spec does not cover and both
|
||||
options look equally large;
|
||||
- you believe a third-party dependency is genuinely needed (the spec says it is not);
|
||||
- the packaging toolchain (`start-cli`, Docker) is missing, so a Phase C verification cannot run.
|
||||
|
||||
Ask only about the four open questions in `docs/spec.md` §13 if they block you; otherwise leave
|
||||
them alone.
|
||||
|
||||
## Report format for every step
|
||||
|
||||
Reply with exactly this, nothing longer:
|
||||
|
||||
```
|
||||
Step <number>: <title>
|
||||
Files: <paths>
|
||||
Changed: <one or two lines on what the code does>
|
||||
Verification: <the command> -> <the observed result>
|
||||
Commit: <message>
|
||||
Next: <the next step number and title>
|
||||
```
|
||||
|
||||
If you stopped to ask, replace `Next:` with `Blocked: <the question>`.
|
||||
|
||||
## Definition of done
|
||||
|
||||
`docs/TODO.md` step 43: the unit tests pass, `make` builds `skuld.s9pk`, the package installs on
|
||||
StartOS with a green health check, the golden example in `docs/spec.md` §6.4 reproduces for all
|
||||
three cost-basis methods, the non-taxable account and its `TOT` row behave, a transfer can be
|
||||
created, edited and deleted with the figures returning to their earlier state, and the CSV opens
|
||||
in a spreadsheet.
|
||||
Reference in new issue
Block a user