Skip to content

DEP N: Title

DEP N
Title the decision, as a short statement in sentence case
Author Name
Status Draft | Accepted | On hold | Implemented | Superseded | Rejected, with its date
Requires the DEPs this one builds on, linked (omit if none)
Created YYYY-MM-DD
Version the datarecord release it ships in, Unreleased until then (omit while a draft)
Replaces the DEP this one makes obsolete, linked (omit if none)
Superseded-By the DEP that makes this one obsolete, linked, with the part it replaces (omit if none)

Once implemented, this paragraph reads: The design landed in [x](…) and [y](…). Where they and this DEP differ, follow those pages. It links the reference and about pages the design landed in.

A DEP is under 1,500 words. Each rule is stated once, in the section it belongs to. Cut what restates a rule, narrates how the design was found, or describes internals you can look up in the code.

Abstract

What changes, in two or three sentences.

Motivation

The problem, in the terms of someone who uses datarecord today.

Specification

The design: what the schema, the format on disk and the API become, as short statements or a table.

Rationale

Why this design, only where the rule does not already state it, in a short paragraph each. Then what it costs: what breaks, what gets slower and what becomes harder to state in a schema or a call.

Usage

What a user writes with it, as short examples of what changes. On implementation these move to the how-to guides.

Implementation notes

The steps it is built in, in order, one line each, and the checks that pass once it is built. On implementation, where the build departs from the text above.

Rejected ideas

What else was considered, and why not, in a line or two each.

Open issues

What it leaves unsettled, a line each. On implementation, what is still open moves to open questions.