Skip to content
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.

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

design-proposals: Clean template and add feature lifecycle section #343

Closed
wants to merge 1 commit into from

Conversation

lyarwood
Copy link
Member

@lyarwood lyarwood commented Nov 4, 2024

/cc @xpivarc
/cc @vladikr
/cc @EdDev

What this PR does / why we need it:

As discussed at the unconference for v1.5.0 [1] we should start documenting the expected lifecycle of a given feature within our design proposals before later moving this tracking to an issue.

This change cleans up the template, removing multiple top level headings, adding whitespace around headings and adds a final section defining the lifecycle of a feature.

[1] https://unconference.kubevirt.io/D62SngbSRXO1uhTAc8Ikqg#xpivarc-Feature-lifecycleFuture-of-proposals---1-1-1-1

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #286

Special notes for your reviewer:

Checklist

This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.

Release note:

NONE

@kubevirt-bot kubevirt-bot added the dco-signoff: yes Indicates the PR's author has DCO signed all their commits. label Nov 4, 2024
@kubevirt-bot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign cwilkers for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Comment on lines +60 to +62
## Feature lifecycle Phases

(How and when will the feature progress through the Alpha, Beta and GA lifecycle phases)
Copy link
Contributor

Choose a reason for hiding this comment

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

Awesome to see this!

In order to provide some more guidance, I'd add sub-sections for alpha, beta and GA.

Suggested change
## Feature lifecycle Phases
(How and when will the feature progress through the Alpha, Beta and GA lifecycle phases)
## Feature lifecycle Phases
(How and when will the feature progress through the Alpha, Beta and GA lifecycle phases)
### Alpha:
### Beta:
### GA:

The Kubernetes KEP template does so with a comment:

#### Alpha

- Feature implemented behind a feature flag
- Initial e2e tests completed and enabled

#### Beta

- Gather feedback from developers and surveys
- Complete features A, B, C
- Additional tests are in Testgrid and linked in KEP

#### GA

- N examples of real-world usage
- N installs
- More rigorous forms of testing—e.g., downgrade tests and scalability tests
- Allowing time for feedback

WDYT?

Copy link
Member

Choose a reason for hiding this comment

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

And it should be clear that the phases are not mandatory, e.g. a feature can reach GA directly. Usually if it is trivial.

@lyarwood
Copy link
Member Author

/close

@iholder101 thanks for the review but I think folks want to push ahead with the new enhancements approach in v1.5.0 instead now so I'm going to close this out.

@kubevirt-bot
Copy link

@lyarwood: Closed this PR.

In response to this:

/close

@iholder101 thanks for the review but I think folks want to push ahead with the new enhancements approach in v1.5.0 instead now so I'm going to close this out.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@lyarwood
Copy link
Member Author

/reopen

@kubevirt-bot kubevirt-bot reopened this Nov 19, 2024
@kubevirt-bot
Copy link

@lyarwood: Reopened this PR.

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

As discussed at the unconference for v1.5.0 [1] we should start
documenting the expected lifecycle of a given feature within our design
proposals before later moving this tracking to an issue.

This change cleans up the template, removing multiple top level
headings, adding whitespace around headings and adds a final section
defining the lifecycle of a feature.

[1] https://unconference.kubevirt.io/D62SngbSRXO1uhTAc8Ikqg#xpivarc-Feature-lifecycleFuture-of-proposals---1-1-1-1

Signed-off-by: Lee Yarwood <[email protected]>
@lyarwood lyarwood force-pushed the design-proposals-lifecycle branch from f7663b9 to 28b72ab Compare November 19, 2024 11:03
Copy link
Member

@EdDev EdDev left a comment

Choose a reason for hiding this comment

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

Thank you!

Comment on lines +60 to +62
## Feature lifecycle Phases

(How and when will the feature progress through the Alpha, Beta and GA lifecycle phases)
Copy link
Member

Choose a reason for hiding this comment

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

And it should be clear that the phases are not mandatory, e.g. a feature can reach GA directly. Usually if it is trivial.

@kubevirt-bot kubevirt-bot added the lgtm Indicates that a PR is ready to be merged. label Nov 19, 2024
@kubevirt-bot
Copy link

Pull requests that are marked with lgtm should receive a review
from an approver within 1 week.

After that period the bot marks them with the label needs-approver-review.

/label needs-approver-review

@kubevirt-bot kubevirt-bot added the needs-approver-review Indicates that a PR requires a review from an approver. label Nov 26, 2024
@aburdenthehand
Copy link
Member

@lyarwood Happy to merge this but it looks like it's still pending suggestions. Did you want to take a quick look?

@lyarwood
Copy link
Member Author

@aburdenthehand thanks but #362 is really the future of this stuff, @vladikr would you still like me to land this PR ahead of the new repo and template being created?

/hold

@kubevirt-bot kubevirt-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 11, 2024
@lyarwood lyarwood closed this Dec 17, 2024
@kubevirt-bot
Copy link

/remove-label needs-approver-review

@kubevirt-bot kubevirt-bot removed the needs-approver-review Indicates that a PR requires a review from an approver. label Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dco-signoff: yes Indicates the PR's author has DCO signed all their commits. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm Indicates that a PR is ready to be merged. size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance the design proposal template with a graduation-criteria section
5 participants