diff --git a/rfc/template.md b/rfc/template.md new file mode 100644 index 000000000..75ab32a4a --- /dev/null +++ b/rfc/template.md @@ -0,0 +1,55 @@ + +# RFC-[number]: [Title] + +## Proposers + +- @ +- @ + +## Approvers +- @ +- @ + +## Status + +GH Feature Request: + +> Please keep the status updated in `rfc/README.md`. + +## Abstract + +Describe the problem you are trying to solve and a brief description of why it’s needed. + +## Background +Introduce any background context which is relevant or necessary to understand the feature and design choices. + +## Implementation +Describe the new thing you want to do in appropriate detail, how it fits into the project architecture.
+Provide a detailed description of how you intend to implement this feature, this may be fairly extensive and have large subsections of its own or it may be a few sentences.
+Use judgement to decide on how detailed the description needs to be based on the scope of the change. If unclear, you can ask questions in dev@xtable.apache.org. + +## Rollout/Adoption Plan + +- Are there any breaking changes as part of this new feature/functionality? +- What impact (if any) will there be on existing users? +- If we are changing behavior how will we phase out the older behavior? When will we remove the existing behavior? +- If we need special migration tools, describe them here. + +## Test Plan + +Describe in few sentences how the RFC will be tested. How will we know that the implementation works as expected? How will we know nothing breaks? \ No newline at end of file