docs: add CONTRIBUTING-DEV.adoc (how to add a backend / drift category / overlay)#74
Merged
Merged
Conversation
Closes #63. `.github/CONTRIBUTING.md` covers RSR conventions (commit signing, contractiles, repo structure) but not "how do I add code to *this* codebase?" Add a developer-facing guide with three concrete walkthroughs: - adding a new database backend (enum variant + dialect + tests) - adding a new drift category (ADR + measure fn + report wiring) - adding a new Tier 2 overlay (Tier2Config field + DDL + interceptor) Each walkthrough is an interactive checklist so PR authors can paste it into a PR body and tick items as they go. The checklists reference real file paths from the current tree, not aspirational ones. The clone/build/test section also documents the Windows integration-test gotcha (TOML path escape) so contributors don't chase it. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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.
Summary
Per V-L3-T1:
.github/CONTRIBUTING.mdcovers RSR conventions but not "how do I add code to this codebase?" Add a developer-facing guide with three concrete walkthroughs:Each is an interactive checklist (paste into PR body, tick as you go) that references real file paths in the current tree.
Closes
Test plan
CONTRIBUTING-DEV.adocsrc/paths verified against current tree (DatabaseBackend,DriftCategory,Tier2Config, etc.)