From 2aa660f99db76f198906c14005e944dffbe383e2 Mon Sep 17 00:00:00 2001 From: vinoth chandar Date: Tue, 28 Sep 2021 10:33:27 -0600 Subject: [PATCH] [MINOR] Add a RFC template and folder (#3726) --- rfc/README.md | 30 ++++++++++++++++++++++++++ rfc/template.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 87 insertions(+) create mode 100644 rfc/README.md create mode 100644 rfc/template.md diff --git a/rfc/README.md b/rfc/README.md new file mode 100644 index 000000000..7ab23b014 --- /dev/null +++ b/rfc/README.md @@ -0,0 +1,30 @@ + +# RFCs + - The RFC process is documented on our [site](https://hudi.apache.org/contribute/rfc-process). Please familiarize yourself with it, before working a new RFC. + - Status can be one of these values: `UNDER REVIEW` (or) `IN PROGRESS` (or) `ABANDONED` (or) `COMPLETED`. + +The list of all RFCs can be found here. + +> This list is a work-in-progress. For all the existing RFCs, please go [here](https://cwiki.apache.org/confluence/display/HUDI/RFC+Process) for now. + + +| RFC Number | Title | Status | +| ------------- | ------------- |------------- | +| ... | ... | ... | +| [34](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=188745980) | Hudi BigQuery Integration |`UNDER REVIEW` | +| [35](https://cwiki.apache.org/confluence/display/HUDI/RFC-35%3A+Make+Flink+MOR+table+writer+in+a+streaming+way) | Make Flink MOR table writing streaming friendly | `UNDER REVIEW` | diff --git a/rfc/template.md b/rfc/template.md new file mode 100644 index 000000000..fef845240 --- /dev/null +++ b/rfc/template.md @@ -0,0 +1,57 @@ + +# RFC-[number]: [Title] + + + +## Proposers + +- @ +- @ + +## Approvers + - @ + - @ + +## Status + +JIRA: + +> 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 much 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 based on the scope of the change. + +## Rollout/Adoption Plan + + - 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 + +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 broke?. \ No newline at end of file