minikube/enhancements/template.md

42 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2019-10-01 20:14:43 +00:00
# Your inspiring proposal title
2019-09-25 22:58:09 +00:00
2019-10-01 20:14:43 +00:00
* First proposed: <date>
* Authors: $full_name (@github-handle), $full_name2 (@github_handle2)
2019-09-25 22:58:09 +00:00
## Reviewer Priorities
Please review this proposal with the following priorities:
* Does this fit with minikube's [principles](https://minikube.sigs.k8s.io/docs/concepts/principles/)?
2019-09-25 22:58:09 +00:00
* Are there other approaches to consider?
* Could the implementation be made simpler?
* Are there usability, reliability, or technical debt concerns?
2019-09-25 22:58:09 +00:00
Please leave the above text in your proposal as instructions to the reader.
## Summary
2019-10-01 20:14:43 +00:00
_(1 paragraph) What are you proposing, and why is it important to users and/or developers?_
2019-09-25 22:58:09 +00:00
## Goals
* _A bulleted list of specific goals for this proposal_
* _How will we know that this proposal has succeeded?_
## Non-Goals
* _A bulleted list of what is out of scope for this proposal_
* _Listing non-goals helps to focus the discussion_
## Design Details
2019-10-01 20:14:43 +00:00
_(2+ paragraphs) A short overview of your implementation idea, containing only as much detail as required to convey your idea._
2019-09-25 22:58:09 +00:00
_If you have multiple ideas, list them concisely._
_Include a testing plan to ensure that your enhancement is not broken by future changes._
## Alternatives Considered
_Alternative ideas that you are leaning against._