Coder/deepseek-harness
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus

Browse Source 
Define the in-file RFC contract in docs/rfc/README.md § The file format:
the header block (`# RFC: <title>` plus a dateless Status enum
cross-checked against the lifecycle folder), the per-lifecycle body
skeleton (a Problem opener everywhere; Proposal/Alternatives considered/
Acceptance criteria/Risks in proposed/; present-tense Decision/
Consequences with proposal-era headings banned in implemented/; the
frozen proposal shape in rejected/), and a mandatory Alternatives
considered section with a date-fenced grandfather comment for pre-format
RFCs whose alternatives are not reconstructible from the record.

Enforce it with a new doc-sync gate, scripts/verify-rfc-format.ts, and
normalize all 112 RFCs to it: ~15 Status-line spellings collapse to the
enum, 29 Context openers become Problem, the 39 legacy-format XXX debt
markers are resolved and banned from reappearing, proposal-era sections
in implemented RFCs are rewritten to shipped reality (including the
web/fs/subagent seam RFCs' migration plans and test checklists, closing
the doc-tiers deferred-work item on the web seam), every RFC gains an
Alternatives considered section or the grandfather comment, and the
bilingual pair is re-mirrored and re-recorded.

Move the generated index tables out of README.md into a fully generated
docs/rfc/INDEX.md — gen-rfc-index now writes the whole file, and
verify-rfc-classification checks its freshness and rejects index-shaped
rows in the curated README — which makes room for the format contract to
live in the README front door instead of a separate FORMAT.md.

The decision record, and the first RFC written in the new format, is
docs/rfc/implemented/process/2026-07-05-uniform-rfc-format.md.
This commit is contained in:
Tianyi Cui
2026-07-05 22:58:25 +08:00
parent d5cb3297ad
commit e6fad266a6
123 changed files with 1221 additions and 847 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
scripts/rfc-index.ts
View File

@@ -9,11 +9,11 @@
* folder IS the label, and both sets are CLOSED — extending either means
* amending this module AND the README's Classification prose.
*
* The README's per-lifecycle tables are GENERATED between marker comments
* (`<!-- gen-rfc-index:begin {lifecycle} -->` … `end`): section headings and
* rows are derived from each RFC's path (lifecycle/class), H1 (title, with an
* optional `RFC: ` prefix stripped), and filename date, sorted by date then
* filename. Prose outside the markers is curated by hand and never touched.
* The index (`docs/rfc/INDEX.md`) is GENERATED in full: per-lifecycle sections
* whose rows are derived from each RFC's path (lifecycle/class), H1 (title,
* with an optional `RFC: ` prefix stripped), and filename date, sorted by date
* then filename. The curated prose lives in README.md, which carries no index
* rows at all.
*/
import { readFileSync, readdirSync } from 'node:fs'
@@ -101,14 +101,8 @@ export function walkRfcTree(): { rfcs: Rfc[]; errors: string[] } {
return { rfcs, errors }
}
/** The begin/end marker lines that delimit one lifecycle's generated region. */
const markers = (lifecycle: string): { begin: string; end: string } => ({
begin: `<!-- gen-rfc-index:begin ${lifecycle} -->`,
end: `<!-- gen-rfc-index:end ${lifecycle} -->`,
})
/**
* Render one lifecycle's generated region body: a `### {Class}` heading plus a
* Render one lifecycle's section body: a `### {Class}` heading plus a
* `| Title | First proposed |` table for every non-empty class, in CLASSES
* order, rows sorted by date then filename.
*/
@@ -126,48 +120,21 @@ function renderLifecycle(rfcs: Rfc[], lifecycle: string): string {
}
/**
* Splice freshly rendered regions into the README text. Throws when a marker
* pair is missing, duplicated, or out of order, when a region does not sit
* under its own `## {Lifecycle}` heading, or when an index-shaped table row
* (a `| [title](lifecycle/…)` line) appears OUTSIDE the generated regions —
* the markers are part of the curated prose, the heading above each region is
* the one its lifecycle names, and index rows live only inside the regions
* (prose links to RFCs remain fine anywhere).
* Render the complete `docs/rfc/INDEX.md` content: a generated-file banner
* followed by one `## {Lifecycle}` section per lifecycle in canonical order.
* The whole file is generated state — there is no curated region to preserve.
*/
export function spliceReadme(readme: string, rfcs: Rfc[]): string {
let out = readme
const regions: Array<{ from: number; to: number }> = []
export function renderIndex(rfcs: Rfc[]): string {
const parts = [
'# RFC index',
'',
'Generated by `pnpm run gen-rfc-index` from the RFC tree — never edit by hand; `verify-rfc-classification` fails when this file is stale. The curated front door — layout, classification, when to write one, and the in-file format — is [README.md](README.md).',
]
for (const lifecycle of LIFECYCLES) {
const { begin, end } = markers(lifecycle)
const beginAt = out.indexOf(begin)
const endAt = out.indexOf(end)
if (beginAt === -1 || endAt === -1 || endAt < beginAt) {
throw new Error(`README.md is missing the ${JSON.stringify(begin)} … ${JSON.stringify(end)} marker pair`)
}
if (out.indexOf(begin, beginAt + 1) !== -1 || out.indexOf(end, endAt + 1) !== -1) {
throw new Error(`README.md has a duplicated ${lifecycle} index marker`)
}
// The region must sit directly under its own lifecycle heading: the last
// H2 above the begin marker is `## {Heading(lifecycle)}`, or the heading
// itself has drifted while the generated table stayed put.
const before = out.slice(0, beginAt)
const lastH2 = [...before.matchAll(/^##\s+(.+?)\s*$/gm)].at(-1)?.[1]
if (lastH2 !== heading(lifecycle)) {
throw new Error(`README.md: the ${lifecycle} index region is not under a "## ${heading(lifecycle)}" heading (found "## ${lastH2 ?? '<none>'}")`)
}
out = `${out.slice(0, beginAt + begin.length)}\n${renderLifecycle(rfcs, lifecycle)}\n${out.slice(endAt)}`
regions.push({ from: out.indexOf(begin), to: out.indexOf(markers(lifecycle).end) + markers(lifecycle).end.length })
parts.push('', `## ${heading(lifecycle)}`, '', renderLifecycle(rfcs, lifecycle))
}
// Index rows are generated state: a table row linking into a lifecycle
// folder anywhere OUTSIDE the regions is a hand-added index entry the
// generator would never reconcile.
let offset = 0
for (const line of out.split('\n')) {
const inRegion = regions.some(r => offset >= r.from && offset < r.to)
if (!inRegion && /^\|\s*\[[^\]]+\]\((?:proposed|implemented|rejected)\//.test(line)) {
throw new Error(`README.md: index-shaped row outside the generated regions: ${JSON.stringify(line.slice(0, 80))}`)
}
offset += line.length + 1
}
return out
return `${parts.join('\n')}\n`
}
/** Matches an index-shaped table row (a `| [title](lifecycle/…) |` line) — generated state that must not appear in curated prose. */
export const INDEX_ROW = /^\|\s*\[[^\]]+\]\((?:proposed|implemented|rejected)\//