add(repo): agent guidelines

2026-08-17 12:52:33 +02:00
parent 078413c030
commit 8903c14ed8
2 changed files with 65 additions and 0 deletions
@@ -0,0 +1,64 @@
+# Agent guidelines
+
+A personal recipe collection in Markdown. One recipe per file.
+
+## Layout
+
+`<meal>/<dish-family>/<recipe>.md` — e.g. `dinner/risotto/pea-risotto.md`.
+
+## Recipe template
+
+```markdown
+# English Name (Original Name)
+
+One-line factual description. Note if vegetarian/vegan.
+
+- **Source:** [site.dk - Original Title](url)
+- **Serves:** 4-6
+- **Time:** 30-45 min
+
+## Ingredients
+
+- 200 g frozen peas
+- A handful of green beans (optional)
+
+## Method
+
+1. Numbered steps.
+
+## Notes
+
+- Practical tips learned from cooking it.
+
+## Related
+
+- [Other recipe](url)
+```
+
+Omit sections that have nothing to say. Wrap prose at ~90 characters.
+
+## Writing style
+
+- **No em dashes or en dashes.** Use a hyphen (`-`) for ranges (`4-6`, `30-45 min`) and for
+  mid-sentence breaks, or rewrite the sentence.
+- **Plain and factual.** No food-blog adjectives. "Pea risotto with squash and green beans",
+  not "spring-like, comforting pea risotto".
+- Metric units, Danish-style volumes where the source uses them (dl, L, g).
+- Keep the original-language recipe name in parentheses in the title.
+
+## Optional ingredients
+
+Mark optional items with `(optional)` in **both** the ingredient list and the method step
+that uses them. Only mark things that are genuinely optional - a risotto needs its cheese.
+
+## Commits
+
+Subject line only, in the form `<type>(<dish-family>): <lowercase summary>`:
+
+- `add(risotto): pea risotto from vegetariskhverdag.dk`
+- `update(risotto): small corrections based on experience`
+
+Types seen so far: `add`, `update`.
+
+**Never add a commit body or description, and never add a `Co-Authored-By` trailer or any
+other footer.** The subject line is the whole commit message.