This directory contains Architecture Decision Records (ADRs) specific to the
katana-openapi-client TypeScript package.
An Architecture Decision Record (ADR) is a document that captures an important architectural decision made along with its context and consequences.
We use the format proposed by Michael Nygard in his article Documenting Architecture Decisions:
- Title: A short noun phrase describing the decision
- Status: Proposed | Accepted | Deprecated | Superseded
- Context: What is the issue that we're seeing that is motivating this decision?
- Decision: What is the change that we're proposing and/or doing?
- Consequences: What becomes easier or more difficult to do because of this change?
- ADR-TS-001: Composable Fetch Wrappers - Transport layer architecture using composable fetch functions
- ADR-TS-002: Hey API Code Generation - Use @hey-api/openapi-ts for SDK generation
- ADR-TS-003: Biome for Linting - Use Biome instead of ESLint
- Copy an existing ADR as a template
- Update the number (NNNN) to be the next sequential number
- Fill in the sections
- Create a PR for discussion
- After acceptance, update status to "Accepted"
- Client Guide - User guide for the TypeScript client
- Cookbook - Common usage patterns
- Testing Guide - Testing strategy and patterns
- Python Client ADRs - Python client decisions