Conversation
Adds design-proposals/template.md as the starting point for new proposals. Sections follow a narrative order reviewers can read top-down: metadata → overview → scope/context → goals → design → consequences (user-facing changes, upgrade/rollback, security, failure cases) → testing → rollout → open questions → alternatives. Each section has a short HTML comment explaining what belongs in it and what to omit. Alternatives sits at the end so reviewers can evaluate rejected options against the already-described design. Proposed as an alternative to #3. Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 59 minutes and 50 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Code Review
This pull request introduces a new Markdown template for design proposals, providing a structured format for documenting system changes. The review feedback suggests several improvements to the template, such as adding a reminder for users to rename the file, including a 'Rejected' status for proposals, and ensuring consistent document structure by using placeholders for empty sections.
| @@ -0,0 +1,102 @@ | |||
| # Your proposal title | |||
There was a problem hiding this comment.
Add a comment at the top of the template to remind users to rename the file to README.md and place it in its own directory, as per the instructions in design-proposals/README.md.
| # Your proposal title | |
| <!-- Rename this file to README.md and place it in a sub-directory under design-proposals/ --> | |
| # Your proposal title |
There was a problem hiding this comment.
Added a reminder at the top of the template that authors should rename the file to README.md and place it in a sub-directory under design-proposals/, matching the convention stated in design-proposals/README.md. Commit: 657fe1a.
| - **Title:** `Your full title` | ||
| - **Author(s):** `@your-github-handle, @coauthor` | ||
| - **Date:** `YYYY-MM-DD` | ||
| - **Status:** Draft | Review | Accepted | Superseded |
There was a problem hiding this comment.
There was a problem hiding this comment.
Added — Status is now Draft | Review | Accepted | Rejected | Superseded. Commit: 657fe1a.
| <!-- Status transitions: Draft → Review (PR opened) → Accepted (merged) | ||
| or Superseded (replaced by a later proposal; link it). --> |
There was a problem hiding this comment.
Update the status transition documentation to include the Rejected state.
| <!-- Status transitions: Draft → Review (PR opened) → Accepted (merged) | |
| or Superseded (replaced by a later proposal; link it). --> | |
| <!-- Status transitions: Draft → Review (PR opened) → Accepted (merged), | |
| Rejected, or Superseded (replaced by a later proposal; link it). --> |
There was a problem hiding this comment.
Updated the transitions comment to include Rejected alongside Superseded. Commit: 657fe1a.
|
|
||
| <!-- Sibling or follow-up proposals and anything deliberately deferred. | ||
| Link them by repo path or URL. If this proposal must land before or after | ||
| another, say so. Omit the section if there are no related proposals. --> |
There was a problem hiding this comment.
To maintain a consistent document structure across all proposals, it is better to keep the "Scope and related proposals" section even if empty, using a placeholder like "None". This confirms the author has considered the scope.
| another, say so. Omit the section if there are no related proposals. --> | |
| another, say so. If there are no related proposals, state "None". --> |
There was a problem hiding this comment.
Keeping the omit form — a proposal that has nothing to say about scope shouldn't reserve boilerplate for it, and a literal None placeholder tends to linger past the point where it's still accurate. The existing wording already invites authors to consider related work; if they don't call any out, a reader can take that as "none."
- Add a top-of-file comment reminding authors to rename to README.md and place it in a sub-directory under design-proposals/. - Add Rejected as a status state and include it in the transitions comment. Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
Summary
Adds
design-proposals/template.mdas the starting point for newproposals. Proposed as an alternative to #3 — the repo should land one
of the two.
Compared to #3, this version:
match the requirement already stated in
design-proposals/README.md.Adds a
Statusline for long-lived docs (Draft / Review / Accepted /Superseded).
responsibility; sub-sections are H3 only when they belong under the
parent (e.g.
### Non-goalsunder## Goals).one
## Overview+## Contextpair. The three-way split in [docs] Add a proposal template #3tends to produce the same paragraph written three times.
## Alternatives consideredto the end. Reviewers can'tevaluate rejected options without first seeing the chosen design.
Matches KEP/KubeVirt convention.
## Scope and related proposals. Cross-proposal scopingcomes up as soon as there is more than one proposal in flight (see
design-proposals: tenant module overrides #4 for a live example).
## Failure and edge casesas a first-class section ratherthan a bullet under Trade-offs. Surfaces concrete misbehaviors
reviewers can poke at.
into peer sections. Security and Testing are not sub-concerns of
rollback.
## Open questionsso authors have a place to parkunresolved points instead of scattering them through the body.
#4 was drafted against this shape and fits it naturally, which was the
main prompt for proposing this variant.
Test plan
metadata placeholders display as intended
section order reads naturally top-down