You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CLAUDE.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,14 @@ Guidance for AI agents (Claude Code, etc.) working in this repository.
6
6
7
7
`httpware` is a Python async HTTP client framework for building resilient service clients. It supersedes `community-of-python/base-client` and ships under the `modern-python` org. The framework owns the abstraction layer above the underlying HTTP client (`httpx2` by default); consumers never import the transport.
8
8
9
-
**Source-of-truth planning artifacts** live in this repo under `docs/`:
-`docs/epics.md` — 6 epics, 32 stories with Given/When/Then acceptance criteria
14
-
-`docs/product-brief-httpware.md` — executive brief (history of how the project was scoped)
15
-
-`docs/product-brief-httpware-distillate.md` — PRD-ready detail pack with verified facts, API patterns, performance specifics, rejected alternatives, open questions
11
+
-[`docs/engineering.md`](docs/engineering.md) — the distilled design reference: invariants and *why*, the five protocol seams, exception contract, module layout, testing patterns, optional-extras pattern, remaining roadmap. Read this before adding any new module or extension point.
12
+
-[`docs/deferred-work.md`](docs/deferred-work.md) — review-surfaced items that are real but not actionable now.
13
+
-[`docs/superpowers/specs/`](docs/superpowers/specs/) and [`docs/superpowers/plans/`](docs/superpowers/plans/) — per-feature design specs and implementation plans (active work).
14
+
-[`docs/archive/`](docs/archive/) — historical bmad-era planning bundle (PRD, architecture, epics, product briefs, per-story specs for 1-1 through 1-5). Consult only for original rationale or specific FR/NFR citations.
16
15
17
-
Stories under active dev live in `docs/stories/`. (Initial planning artifacts were authored in the predecessor repo `community-of-python/base-client` and copied here at the end of Story 1.1; both copies are kept in sync until base-client is archived.)
16
+
**Per-feature workflow:** brainstorming → spec in `docs/superpowers/specs/` → writing-plans → plan in `docs/superpowers/plans/` → executing-plans (or subagent-driven-development) → requesting-code-review → finishing-a-development-branch. Topic slugs are kebab-case descriptions (`msgspec-decoder-adapter`), not story IDs.
18
17
19
18
## Commands
20
19
@@ -100,5 +99,5 @@ Five documented internal boundaries. AI agents must respect them — never cross
100
99
101
100
## When in doubt
102
101
103
-
- Check the architecture document (`base-client/docs/architecture.md`) before adding a new module or extension point.
102
+
- Check [`docs/engineering.md`](docs/engineering.md) before adding a new module or extension point; `docs/archive/architecture.md` has the deeper historical rationale if needed.
104
103
- Surface ambiguity as a documentation gap rather than improvising.
This directory contains the bmad-era planning artifacts for `httpware`:
4
+
5
+
-`prd.md` — 47 functional and 25 non-functional requirements.
6
+
-`architecture.md` — twelve architectural decisions, the five protocol seams, full module layout.
7
+
-`epics.md` — six epics with 32 stories.
8
+
-`product-brief-httpware.md` and `product-brief-httpware-distillate.md` — executive brief and detail pack from the predecessor `community-of-python/base-client` scoping exercise.
9
+
-`stories/` — per-story specs (1-1 through 1-5) and the retired `sprint-status.yaml`.
10
+
11
+
These files are **historical reference, not authoritative**. The load-bearing decisions were distilled into [`../engineering.md`](../engineering.md) on 2026-05-31 when the project switched workflows from bmad to superpowers. Consult these archived files only when you need:
12
+
13
+
- Original rationale behind a decision (e.g., "why did we choose `httpx2` over `aiohttp`?").
14
+
- The specific FR/NFR numbers that a future spec wants to cite (e.g., `archive/prd.md#NFR-12`).
15
+
- The Given/When/Then acceptance criteria from a completed story.
16
+
17
+
For everything else — invariants, seams, module layout, conventions, the remaining roadmap — read `../engineering.md` and `../../CLAUDE.md`.
0 commit comments