docs(rfc): add RFC process; graduate design notes to RFCs - #127
Merged
Conversation
Add rfc/ for internal design proposals (distinct from user-facing docs_src/): - rfc/README.md documents the lifecycle (Draft/Accepted/Rejected/Superseded/ Implemented) and an explicit accept/reject review methodology gated on the north star (embedded/ACID/recovery/access-methods/multi-process/format stability), decisions recorded in-RFC. - rfc/0000-template.md, rfc/INDEX.md (the register). - Graduate the design notes: docs/design/lsm.md -> RFC 0001 (adaptive LSM), buffer-swip-aio.md -> RFC 0002; the research surveys -> rfc/0002/. The lab/lsm adaptive-controller prototype -> rfc/0001/ (builds + self-checks in its new home). ROADMAP references in the moved docs replaced (ROADMAP is now private). docs/design/ removed (empty). Modeled on the ~/ws/ra/rfcs process. lab/ now holds only the bench suite (moved to test/bench in a follow-up).
Coccinelle convention checksNo new violations. ✅ Resolved since baseline (2) -- update dist/cocci/baseline.txt to lock these in. |
ABI diff vs
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
rfc/for internal design proposals — distinct from the user-facingdocs_src/(published to libdb.org). RFCs are where non-trivial design intent is written, reviewed, and explicitly accepted/rejected.rfc/README.md— the lifecycle (Draft / Accepted / Rejected / Superseded / Implemented) and an explicit review methodology gated on the north star (embedded / ACID / recovery / access methods / multi-process / format & ABI stability); decisions are recorded in the RFC with a dated rationale. Modeled on~/ws/ra/rfcs.rfc/0000-template.md,rfc/INDEX.md(the register).git mv, history preserved):docs/design/lsm.md→ RFC 0001 (Adaptive LSM),buffer-swip-aio.md→ RFC 0002; the research surveys →rfc/0002/. Thelab/lsm/adaptive-controller prototype →rfc/0001/(builds +make checkpasses in its new home).docs/design/removed (now empty).lab/now holds only thebenchmicrobenchmark suite — relocated totest/benchin the follow-up build-layout PR.