Design and RFC
Use this to draft integration RFCs and architecture proposals.
RFC structure
- Problem statement and constraints
- Current-state evidence
- Goals and non-goals
- Options considered
- Chosen design and rationale
- API design implications
- SDK design implications
- Backward compatibility and migration
- Testing strategy
- Rollout and observability plan
- Risks and open questions
Option analysis rules
- Provide at least two viable options when feasible.
- Include explicit tradeoffs: complexity, risk, latency, cost, operability.
- State why rejected options fail constraints.
- Tie decision to principles in
principles.md.
API and SDK guidance
- Keep API contract vendor-neutral where possible.
- Use stable abstractions in SDK surface; keep vendor-specific config scoped.
- Define pagination, retries, and error translation behavior explicitly.
- Document deprecation/migration when changing public surfaces.