From a2b29fe6ffa16a0af5635505df7250f27724260a Mon Sep 17 00:00:00 2001 From: Brett Parson Date: Sat, 29 Aug 2026 15:56:32 -0500 Subject: Restructure roadmap and add changelog Phase plan for v0.2.0 through v1.0.0, Keep-a-Changelog conventions, and agent docs with build/test and beads-operations guidance. --- CLAUDE.md | 38 ++++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 20 deletions(-) (limited to 'CLAUDE.md') diff --git a/CLAUDE.md b/CLAUDE.md index 50af487..e0820ca 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,6 +1,23 @@ # Project Instructions for AI Agents -This file provides instructions and context for AI coding agents working on this project. +**Source of truth: [AGENTS.md](AGENTS.md) — read it first.** + +This file is a lightweight mirror for agents that look for `CLAUDE.md`. If the +two disagree, `AGENTS.md` wins. The beads block below is auto-managed by the +`bd` hooks. + +The short version: + +- **Build & Test**: `composer install` once, then `composer check` (lint + + unit tests) before finishing work. `composer bench` for the scaling + benchmark. +- **Tracking**: use `bd` for ALL task tracking — never TodoWrite or markdown + TODO lists. Serialize `bd` commands (embedded Dolt is single-writer). +- **Changelog**: every user-facing change gets a line under `[Unreleased]` in + `CHANGELOG.md`. +- **Session close**: file issues for remaining work, run `composer check`, + update issue status, then push (`git pull --rebase`, `bd dolt push`, + `git push`). Work is not complete until the push succeeds. ## Beads Issue Tracker @@ -48,22 +65,3 @@ bd close # Complete work - NEVER say "ready to push when you are" - YOU must push - If push fails, resolve and retry until it succeeds - - -## Build & Test - -_Add your build and test commands here_ - -```bash -# Example: -# npm install -# npm test -``` - -## Architecture Overview - -_Add a brief overview of your project architecture_ - -## Conventions & Patterns - -_Add your project-specific conventions here_ -- cgit v1.2.3