DeepSeek/deepseek-harness
1
0
Fork 0
mirror of https://github.com/deepseek-ai/deepseek-harness synced 2026-08-15 21:04:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(rfc): address Codex review — fence-aware format gate, exact corpus counts

Browse Source 
Two findings from the pre-ready review, both verified:

- verify-rfc-format scanned raw lines, so an RFC quoting a Status line,
  a banned heading, or the grandfather comment inside a fenced example
  would false-positive. The content scans (duplicate Status, H2 headings,
  banned headings, grandfather, legacy marker) now ignore fenced blocks;
  the positional header-block checks stay raw. Verified: a fenced
  'Status: implemented' + '## Plan' + grandfather quote inside a walked
  RFC no longer trips the gate.

- The companion RFC's pre-format corpus counts were imprecise: 27
  distinct Status spellings (reasons collapsed), not 'some fifteen';
  nineteen implemented files carrying thirty proposal-era heading
  occurrences, not 'over twenty files'; three English files (plus one zh
  counterpart) with no status, not four.
This commit is contained in:
Tianyi Cui
2026-07-05 23:45:34 +08:00
parent e6fad266a6
commit 0e29de459e
2 changed files with 20 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
scripts/verify-rfc-format.ts
View File

@@ -65,6 +65,17 @@ for (const rfc of rfcs) {
errors.push(`format: ${rfc.rel} — ${msg}`)
}
const lines = readFileSync(resolve(rfcRoot, rfc.rel), 'utf8').split('\n')
// Content scans ignore fenced code blocks: an RFC may legitimately QUOTE a
// status line, a banned heading, or the grandfather comment inside a fence
// (the README's own format section does), and only real prose counts.
let inFence = false
const prose = lines.filter((l) => {
if (l.startsWith('```')) {
inFence = !inFence
return false
}
return !inFence
})
if (!/^# RFC: \S/.test(lines[0] ?? '')) fail('line 1 must be `# RFC: <title>`')
if (lines[1] !== '') fail('line 2 must be blank')
@@ -73,10 +84,12 @@ for (const rfc of rfcs) {
fail(`line 3 must match the ${rfc.lifecycle} status grammar (${String(status)})`)
}
if (lines[3] !== '') fail('line 4 must be blank')
const statusLines = lines.filter((l, i) => i !== 2 && l.startsWith('Status:'))
if (statusLines.length > 0) fail('the line-3 `Status:` line must be the only one in the file')
const statusLines = prose.filter(l => l.startsWith('Status:') && l !== lines[2])
if (statusLines.length > 0 || prose.filter(l => l === lines[2]).length > 1) {
fail('the line-3 `Status:` line must be the only one in the file')
}
const h2s = lines.filter(l => l.startsWith('## ')).map(l => l.trimEnd())
const h2s = prose.filter(l => l.startsWith('## ')).map(l => l.trimEnd())
if (h2s[0] !== '## Problem') fail(`the first section must be \`## Problem\` (got ${JSON.stringify(h2s[0] ?? '<none>')})`)
for (const required of REQUIRED[rfc.lifecycle] ?? []) {
if (!h2s.includes(required)) fail(`missing the required \`${required}\` section`)
@@ -88,12 +101,12 @@ for (const rfc of rfcs) {
}
const hasSection = h2s.includes('## Alternatives considered')
const hasGrandfather = lines.includes(GRANDFATHER)
const hasGrandfather = prose.includes(GRANDFATHER)
if (hasSection && hasGrandfather) fail('carries both `## Alternatives considered` and the grandfather comment — drop the comment')
if (!hasSection && !hasGrandfather) fail('missing `## Alternatives considered` (a pre-format RFC whose alternatives are not reconstructible carries the grandfather comment instead — see docs/rfc/README.md § The file format)')
if (hasGrandfather && rfc.date >= FORMAT_ADOPTED) fail(`the grandfather comment is only valid for RFCs dated before ${FORMAT_ADOPTED}`)
if (lines.some(l => l.includes(LEGACY_MARKER))) fail('carries the retired legacy-format debt marker')
if (prose.some(l => l.includes(LEGACY_MARKER))) fail('carries the retired legacy-format debt marker')
}
if (errors.length === 0) {