From 367e69735735f77e64815fb253fbe3b10d9373a5 Mon Sep 17 00:00:00 2001 From: neza2017 Date: Thu, 8 Jul 2021 16:07:13 +0800 Subject: [PATCH] [skip ci] MEP template (#6366) Signed-off-by: yefu.chen --- docs/design_docs/MEP-Template.md | 47 ++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 docs/design_docs/MEP-Template.md diff --git a/docs/design_docs/MEP-Template.md b/docs/design_docs/MEP-Template.md new file mode 100644 index 0000000000..dc77cea2ff --- /dev/null +++ b/docs/design_docs/MEP-Template.md @@ -0,0 +1,47 @@ +# MEP(Milvus Enhancement Proposals) Templates +Current state: [One of "Under Discussion", "Accepted", "Rejected"] + +ISSUE: link to the github issue + +PRs: link to the github PRs + +Keywords: list keywords about this mep + +Released: + +## Summary(required) + +What are we going to do? + +## Motivation(required) + +Why are we doing this? + +## Public Interfaces(optional) + +Briefly list any new interfaces that will be introduced as part of this proposal or any existing interfaces that will be removed or changed. + +## Design Details(required) + +Describe the new thing you want to do in appropriate detail. This may be fairly extensive and have large subsections of its own. Or it may be a few sentences. Use judgement based on the scope of the change. + +## Compatibility, Deprecation, and Migration Plan(optional) +- What impact (if any) will there be on existing users? +- If we are changing behavior how will we phase out the older behavior? +- If we need special migration tools, describe them here. +- When will we remove the existing behavior? + + +## Test Plan(required) + +Describe in few sentences how the MEP will be tested. We are mostly interested in system tests (since unit-tests are specific to implementation details). How will we know that the implementation works as expected? How will we know nothing broke? + +## Rejected Alternatives(optional) + +If there are alternative ways of accomplishing the same thing, what were they? The purpose of this section is to motivate why the design is the way it is and not some other way. + +## References(optional) + +Briefly list all references + +