From 7cf729c8a9667d51642b036865c1fc1f4e9098c2 Mon Sep 17 00:00:00 2001 From: Sheng Yang Date: Wed, 19 Jan 2022 18:39:35 -0800 Subject: [PATCH] Add `enhancements` directory for Harvester Enhancement Proposal(HEP) Signed-off-by: Sheng Yang --- enhancements/YYYYMMDD-template.md | 61 +++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 enhancements/YYYYMMDD-template.md diff --git a/enhancements/YYYYMMDD-template.md b/enhancements/YYYYMMDD-template.md new file mode 100644 index 0000000000..9ec85ec194 --- /dev/null +++ b/enhancements/YYYYMMDD-template.md @@ -0,0 +1,61 @@ +# Title + +This is the title of the enhancement. Keep it simple and descriptive. + +The file name should be lowercased and spaces/punctuation should be replaced with `-`. + +## Summary + +The Summary section is incredibly important for producing high quality user-focused documentation such as release notes or a development roadmap. + +A good summary is probably at least a paragraph in length. + +### Related Issues + +The URL For the related enhancement issues in Harvester repo. + +## Motivation + +### Goals + +List the specific goals of the enhancement. How will we know that this has succeeded? + +### Non-goals [optional] + +What is out of scope for this enhancement? Listing non-goals helps to focus discussion and make progress. + +## Proposal + +This is where we get down to the nitty gritty of what the proposal actually is. + +### User Stories +Detail the things that people will be able to do if this enhancement is implemented. A good practise is including a comparsion of what user cannot do before the enhancement implemented, why user would want an enhancement and what user need to do after, to make it clear why the enhancement beneficial to the user. + +The experience details should be in the `User Experience In Detail` later. + +#### Story 1 +#### Story 2 + +### User Experience In Detail + +Detail what user need to do to use this enhancement. Include as much detail as possible so that people can understand the "how" of the system. The goal here is to make this feel real for users without getting bogged down. + +### API changes + +## Design + +### Implementation Overview + +Overview on how the enhancement will be implemented. + +### Test plan + +Integration test plan. + +### Upgrade strategy + +Anything that requires if user want to upgrade to this enhancement + +## Note [optional] + +Additional nodes.