From 035adb5762737a89725393f70b92387494db1ceb Mon Sep 17 00:00:00 2001 From: ArthurErlich Date: Sun, 4 Oct 2026 22:31:12 +0200 Subject: [PATCH] chore: add agent-skills config, glossary and example mod Co-Authored-By: Claude Sonnet 5.5 --- .../_metadata/modinfo.json | 15 ++++++ .../content/mod.script.tl | 9 ++++ .../ug_tf3_example_config_change/mod.json | 10 ++++ CLAUDE.md | 13 +++++ CONTEXT.md | 27 ++++++++++ docs/agents/domain.md | 51 +++++++++++++++++++ docs/agents/issue-tracker.md | 35 +++++++++++++ docs/agents/triage-labels.md | 15 ++++++ 8 files changed, 175 insertions(+) create mode 100644 .examples/ug_tf3_example_config_change/_metadata/modinfo.json create mode 100644 .examples/ug_tf3_example_config_change/content/mod.script.tl create mode 100644 .examples/ug_tf3_example_config_change/mod.json create mode 100644 CLAUDE.md create mode 100644 CONTEXT.md create mode 100644 docs/agents/domain.md create mode 100644 docs/agents/issue-tracker.md create mode 100644 docs/agents/triage-labels.md diff --git a/.examples/ug_tf3_example_config_change/_metadata/modinfo.json b/.examples/ug_tf3_example_config_change/_metadata/modinfo.json new file mode 100644 index 0000000..03b3b5c --- /dev/null +++ b/.examples/ug_tf3_example_config_change/_metadata/modinfo.json @@ -0,0 +1,15 @@ +{ + "authors": [ + { + "name": "Urban Games", + "role": "CREATOR" + } + ], + "description": "Simple config change mod", + "summary": "Example config change", + "name": "Example Base Config Change", + "tags": [ + "script" + ], + "url": "" +} diff --git a/.examples/ug_tf3_example_config_change/content/mod.script.tl b/.examples/ug_tf3_example_config_change/content/mod.script.tl new file mode 100644 index 0000000..f689972 --- /dev/null +++ b/.examples/ug_tf3_example_config_change/content/mod.script.tl @@ -0,0 +1,9 @@ +local mod = {} + +mod.preRunFn = function(_configDict : {{string, string}}, _allModParams : {string : {string : integer}}, baseConfig : BaseConfig) + + baseConfig.trainAccelerationFactor = 0.5 + +end + +return mod diff --git a/.examples/ug_tf3_example_config_change/mod.json b/.examples/ug_tf3_example_config_change/mod.json new file mode 100644 index 0000000..8fbe246 --- /dev/null +++ b/.examples/ug_tf3_example_config_change/mod.json @@ -0,0 +1,10 @@ +{ + "modId": "ug_tf3_config_change", + "revision": 1, + "severityAdd": "None", + "severityRemove": "Warning", + "cosmetic": false, + "preRunScript": { + "fileName": "ug_tf3_config_change::mod.script@preRunFn" + } +} diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..999141a --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,13 @@ +## Agent skills + +### Issue tracker + +Issues live in Gitea (`git.arthurerlich.de`), driven with the `tea` CLI. See `docs/agents/issue-tracker.md`. + +### Triage labels + +Default five-role vocabulary (`needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`). See `docs/agents/triage-labels.md`. + +### Domain docs + +Single-context: one `CONTEXT.md` + `docs/adr/` at the repo root. See `docs/agents/domain.md`. diff --git a/CONTEXT.md b/CONTEXT.md new file mode 100644 index 0000000..0ef9d23 --- /dev/null +++ b/CONTEXT.md @@ -0,0 +1,27 @@ +# TpF3 Overtake + +A Transport Fever 3 script-mod that lets road vehicles pass slower vehicles instead of queueing behind them. + +## Language + +**Overtaking**: +A faster vehicle getting past a slower one ahead of it on the same road, as seen by the player. It may be a visual illusion (the passer drives through the blocker) rather than a real lane change. +_Avoid_: Passing, bypass + +**Blocker**: +The slower vehicle ahead that the passer would otherwise queue behind. +_Avoid_: Obstacle, lead vehicle + +**Passer**: +The faster vehicle that overtakes the blocker. +_Avoid_: Overtaker + +**Player-owned vehicle**: +A vehicle belonging to one of the player's lines. Only these are in scope for overtaking. +_Avoid_: AI vehicle, ambient traffic + +**Same-direction multilane road**: +A road with two or more lanes in the passer's direction, where overtaking needs no oncoming-traffic check. + +**Two-way road**: +A road with one lane per direction, where overtaking is only safe if no oncoming vehicle is in the way. diff --git a/docs/agents/domain.md b/docs/agents/domain.md new file mode 100644 index 0000000..b548c53 --- /dev/null +++ b/docs/agents/domain.md @@ -0,0 +1,51 @@ +# Domain Docs + +How the engineering skills should consume this repo's domain documentation when exploring the codebase. + +## Before exploring, read these + +- **`CONTEXT.md`** at the repo root, or +- **`CONTEXT-MAP.md`** at the repo root if it exists — it points at one `CONTEXT.md` per context. Read each one relevant to the topic. +- **`docs/adr/`** — read ADRs that touch the area you're about to work in. In multi-context repos, also check `src//docs/adr/` for context-scoped decisions. + +If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved. + +## File structure + +Single-context repo (most repos): + +``` +/ +├── CONTEXT.md +├── docs/adr/ +│ ├── 0001-event-sourced-orders.md +│ └── 0002-postgres-for-write-model.md +└── src/ +``` + +Multi-context repo (presence of `CONTEXT-MAP.md` at the root): + +``` +/ +├── CONTEXT-MAP.md +├── docs/adr/ ← system-wide decisions +└── src/ + ├── ordering/ + │ ├── CONTEXT.md + │ └── docs/adr/ ← context-specific decisions + └── billing/ + ├── CONTEXT.md + └── docs/adr/ +``` + +## Use the glossary's vocabulary + +When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids. + +If the concept you need isn't in the glossary yet, that's a signal — either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`). + +## Flag ADR conflicts + +If your output contradicts an existing ADR, surface it explicitly rather than silently overriding: + +> _Contradicts ADR-0007 (event-sourced orders) — but worth reopening because…_ diff --git a/docs/agents/issue-tracker.md b/docs/agents/issue-tracker.md new file mode 100644 index 0000000..de35dbb --- /dev/null +++ b/docs/agents/issue-tracker.md @@ -0,0 +1,35 @@ +# Issue tracker: Gitea + +Issues and specs for this repo live as Gitea issues on `git.arthurerlich.de` (repo `haylan/tpf3-overtake`). Use the `tea` CLI for all operations (see the `gitea-tea` skill). + +## Conventions + +- **Create an issue**: `tea issues create --title "..." --description "..."`. Use a heredoc for multi-line bodies. +- **Read an issue**: `tea issues --comments` +- **List issues**: `tea issues list --state open --fields index,title,body,labels` with `--labels` filters as needed. +- **Comment on an issue**: `tea comment "..."` +- **Apply / remove labels**: `tea issues edit --add-labels "..."` / `--remove-labels "..."` +- **Close**: `tea issues close ` (comment first with `tea comment`) + +Infer the repo from `git remote -v` — `tea` does this inside a clone. + +## Pull requests as a triage surface + +**PRs as a request surface: no.** + +## When a skill says "publish to the issue tracker" + +Create a Gitea issue. + +## When a skill says "fetch the relevant ticket" + +Run `tea issues --comments`. + +## Wayfinding operations + +Used by `/wayfinder`. The **map** is a single issue labelled `wayfinder:map`; **child** tickets are issues labelled `wayfinder:` (`research`/`prototype`/`grilling`/`task`) with `Part of #` at the top of the body and listed in the map's task list. + +- **Blocking**: a `Blocked by: #, #` line at the top of the child body. Unblocked when every blocker is closed. +- **Frontier query**: open children of the map, minus any with an open blocker or an assignee; first in map order wins. +- **Claim**: assign the issue to yourself (`tea issues edit --add-assignees `). +- **Resolve**: comment the answer, close the issue, then append a pointer to the map's Decisions-so-far. diff --git a/docs/agents/triage-labels.md b/docs/agents/triage-labels.md new file mode 100644 index 0000000..b716855 --- /dev/null +++ b/docs/agents/triage-labels.md @@ -0,0 +1,15 @@ +# Triage Labels + +The skills speak in terms of five canonical triage roles. This file maps those roles to the actual label strings used in this repo's issue tracker. + +| Label in mattpocock/skills | Label in our tracker | Meaning | +| -------------------------- | -------------------- | ---------------------------------------- | +| `needs-triage` | `needs-triage` | Maintainer needs to evaluate this issue | +| `needs-info` | `needs-info` | Waiting on reporter for more information | +| `ready-for-agent` | `ready-for-agent` | Fully specified, ready for an AFK agent | +| `ready-for-human` | `ready-for-human` | Requires human implementation | +| `wontfix` | `wontfix` | Will not be actioned | + +When a skill mentions a role (e.g. "apply the AFK-ready triage label"), use the corresponding label string from this table. + +Edit the right-hand column to match whatever vocabulary you actually use.