Skip to content

[docs] Add a proposal template #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs] Add a proposal template #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions design-proposals/template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Cozystack Enhancement Proposal: Your short, descriptive title

## Overview

<!--
Write a brief overview of the proposed enhancement (functionality).
-->

## 1. Goal Setting

### Motivation

<!--
Why this enhancement is important.
-->

## Users and User Stories

<!--
Who will benefit from this improvement and what are their key user scenarios
In terms of Jobs To Be Done: what they do now and will stop doing or will do much easier/faster.
-->

### Goals and Non-goals

<!--
Definition of the desired outcome.
Limitations to the scope of the feature.
-->

### Alternatives

<!--
Outline any alternative designs that have been considered
-->

### Trade-offs and Risks

<!--
What are the limitations of this proposal?
What risks can it cause?
-->

## 2. Implementation

## Design and Architecture

<!--
Give a brief and concise description of the solution.
-->

## API Examples

<!--
Examples of configuration, API calls, etc.
-->

### Implementation Phases

<!--
How/if this design will get broken up into multiple phases
-->

## Update/Rollback Compatibility

<!--
Does this feature require migrations in Cozystack services and/or user applications?
Will they happen upon updating Cozystack or separately?
-->

### Security

<!--
Does the enhancement affect security?
What will be done to mitigate the risks?
-->

### Testing

<!--
How will this be tested during the development phase?
How will this
-->
Comment on lines +80 to +83
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

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.

Suggested change
<!--
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.



---

<!--
Based on the KubeVirt enhancement proposal process
https://github.com/kubevirt/enhancements/blob/main/veps/NNNN-vep-template/vep.md
-->