Repository navigation
Proposal Template
| Status | Draft / In review / Accepted / Superseded by NNNN |
| Author | |
| Date | YYYY-MM-DD |
| Repository | ridescoredc-models / ridescoredc-website |
| Decides | the one question this proposal settles, in a sentence |
| Depends on | proposals, PRs or issues that must land first |
| Related | links to design documents and prior discussion |
Three to five sentences. What is proposed, and what changes if the team accepts it. A reader who stops here should be able to say what they are agreeing to.
What is true today, with evidence — file paths, row counts, PR numbers, measurements. Facts that anyone can check, separated from the argument.
What the current state costs, stated concretely. One paragraph or a short list. Each item should be something a reader can recognise from their own experience of the codebase.
The substance. Break into subsections, one per component or decision. For each:
- what it is, in one sentence
- what it contains or does
- who authors or owns it
- one worked example, where an example is shorter than the explanation
Diagrams where the shape matters more than the prose.
| Role | Today | Under this proposal |
|---|---|---|
| model author | ||
| deployer | ||
| frontend developer | ||
| data consumer |
Drop rows that do not apply. Add rows that do.
| Option | Cost | Why the proposal chooses otherwise |
|---|
One row per option that a reader might reasonably suggest. An alternative with no honest cost stated is an alternative that was not considered.
What lands, in what order, and what each piece unblocks. Mark anything explicitly deferred and say what would bring it forward.
| Piece | Unblocks | Deferred until |
|---|
Questions the team must answer, each with the options and what each option costs. A question here blocks a decision; a question the author can settle alone belongs in the proposal body.
| Question | Options | Who decides |
|---|
Where to leave feedback, by when, and what kind of feedback is most useful at this stage. Name the sections where a dissent would change the design versus the ones that are implementation detail.