[docs] Add a proposal template #3
Conversation
Signed-off-by: Nick Volynkin <[email protected]>
WalkthroughA new file, Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
design-proposals/template.md (2)
1-2: Add minimal front-matter for discoverability
Most proposal processes include metadata (status, authors, creation date, etc.) in a YAML front-matter block. This helps tooling parse proposals and eases tracking through lifecycle stages.Example:
+# --- +# title: "<short descriptive title>" +# authors: ["@github-handle"] +# creationDate: "2025-07-01" +# status: "draft" +# ---
24-30: Consider elevating “Goals and Non-goals” to a top-level heading
Placing this section inside Users and User Stories can bury a critical scope definition. Moving it to its own##heading (parallel to Overview and Implementation) makes the template clearer and discourages scope creep.-### Goals and Non-goals +## Goals and Non-goals
| <!-- | ||
| How will this be tested during the development phase? | ||
| How will this | ||
| --> |
There was a problem hiding this comment.
Incomplete sentence—please finish the Testing guidance
The comment at line 82 abruptly ends (“How will this”), leaving authors without clear instructions for writing the Testing section.
Suggested fix:
-<!--
-How will this be tested during the development phase?
-How will this
--->
+<!--
+How will this be tested during development (unit, integration, e2e)?
+What acceptance criteria must be met before merging?
+How will long-term maintenance and regression testing be handled?
+-->📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <!-- | |
| How will this be tested during the development phase? | |
| How will this | |
| --> | |
| <!-- | |
| How will this be tested during development (unit, integration, e2e)? | |
| What acceptance criteria must be met before merging? | |
| How will long-term maintenance and regression testing be handled? | |
| --> |
🤖 Prompt for AI Agents
In design-proposals/template.md around lines 80 to 83, the comment under the
Testing section is incomplete and ends abruptly with "How will this". Complete
the sentence to provide clear guidance on how the Testing section should be
written, ensuring it fully explains what aspects need to be tested and how
testing will be conducted during development.
Summary by CodeRabbit