RFC:

  • Author(s): <name(s), handle(s)>
  • Status: Draft Review Accepted Rejected Superseded by RFC-XXXX
  • Created:
  • Updated:
  • Target Version: <e.g., 0.2.0>

1. Summary

One paragraph explanation of the proposal.

2. Motivation

  • What problems does this solve?
  • Who benefits and how?
  • Why now?

3. Goals & Non‑Goals

  • Goals: bullet list of concrete outcomes
  • Non‑Goals: explicitly out of scope

4. Design Overview

  • High-level architecture
  • Data flow & components
  • Diagrams where helpful

5. Detailed Design

  • APIs and data models (request/response, schemas)
  • Configuration and environment variables
  • CLI/API changes
  • Persistence / state considerations
  • Rollout & migration strategy

6. Alternatives Considered

  • Option A: pros/cons
  • Option B: pros/cons
  • Why the proposed design?

7. Security, Privacy, and Compliance

  • Threat model
  • Secrets handling & access control
  • Data retention & PII

8. Observability & Operations

  • Logging, metrics, tracing
  • SLOs and alerting
  • Failure modes and mitigations

9. Backwards Compatibility

  • Breaking changes
  • Deprecations and migration path

10. Risks & Open Questions

  • Key risks and mitigations
  • Unknowns / to be validated

11. Adoption Plan

  • Phased rollout
  • Docs & enablement
  • Feature flags / guarded rollout

12. Appendix / References

  • Links to prior art, issues, PRs, docs