Skip to content

README

Each non-trivial feature (UI or backend) gets its own folder under specs/<year>/<feature-slug>/ containing three files:

specs/2026/swap-instant-refund/
├─ proposal.md # The "why" — problem, audience, success metrics
├─ design.md # The "what" — technical/UX design, API surface, components used
└─ tasks.md # The "how" — ordered, executable tasks for an agent or human
# Proposal — <feature>
## Problem
## Audience
## Success metrics
## Non-goals
## Open questions
---
feature: <feature>
products: [rechaj-swap-app, rechaj-finance-api]
extends: ../../../products/<primary-product>/DESIGN.md
---
# Design — <feature>
## UX
## Data model
## API
## Components / patterns used
## Edge cases
# Tasks — <feature>
- [ ] Step 1 — small enough that an agent can run it autonomously
- [ ] Step 2
- [ ] Step 3

Every PR that ships a feature should link the three files in its description:

Proposal: specs/2026/<slug>/proposal.md
Design: specs/2026/<slug>/design.md
Tasks: specs/2026/<slug>/tasks.md