aboutsummaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorBrett Parson <brett@brett-parson.com>2026-08-29 15:56:32 -0500
committerBrett Parson <brett@brett-parson.com>2026-08-29 15:56:32 -0500
commita2b29fe6ffa16a0af5635505df7250f27724260a (patch)
tree8ccadc420e2bf8cd997f76d8b54e2bcfc83dbf17 /AGENTS.md
parent965551532d684456b74baf960157c0c2cef7335d (diff)
downloadminiroute-a2b29fe6ffa16a0af5635505df7250f27724260a.tar.gz
miniroute-a2b29fe6ffa16a0af5635505df7250f27724260a.zip
Restructure roadmap and add changelogv0.1.0
Phase plan for v0.2.0 through v1.0.0, Keep-a-Changelog conventions, and agent docs with build/test and beads-operations guidance.
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/AGENTS.md b/AGENTS.md
index ee9b430..47aa32b 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -11,7 +11,16 @@ bd ready # Find available work
bd show <id> # View issue details
bd update <id> --claim # Claim work atomically
bd close <id> # Complete work
-bd create # Create v0.1.0 beads individually (see docs/roadmap.md)
+bd create # Create beads per the phase plan (see docs/roadmap.md)
+```
+
+## Build & Test
+
+```bash
+composer install # once (phpunit is dev-only)
+composer check # lint + unit tests — the quality gate
+composer test # vendor/bin/phpunit only
+composer bench # registration/dispatch scaling benchmark (manual, not CI)
```
## Conventions
@@ -21,6 +30,22 @@ bd create # Create v0.1.0 beads individually (see docs/roadmap.md)
- Attributes live in `src/Attribute/`.
- Keep runtime dependencies at zero; `phpunit` is dev-only. See `README.md`.
- Controllers accept `RequestInterface` and return `ResponseInterface`.
+- Known-issue baselines live in `tests/Regression/KnownIssuesTest.php` and
+ flip to desired behavior when their fix lands — never delete them.
+- Every user-facing change gets a line in `CHANGELOG.md` under Unreleased.
+
+## Beads operations
+
+- The embedded Dolt database allows ONE writer at a time: never run two `bd`
+ commands in parallel (they collide on the lock). Serialize them.
+- Never use `bd edit` (opens an editor). Use `bd update --title/--description`.
+- `bd prime` restores full workflow context after compaction or a new session.
+
+## Changelog
+
+- Add a line under `[Unreleased]` for every user-facing change.
+- Release: rename Unreleased to the version, bump `composer.json`, tag `vN.N.N`,
+ push. See `CHANGELOG.md` header for the full convention.
## Non-Interactive Shell Commands