1
0

[MINOR] Add a RFC template and folder (#3726)

This commit is contained in:
vinoth chandar
2021-09-28 10:33:27 -06:00
committed by GitHub
parent f0585facd6
commit 2aa660f99d
2 changed files with 87 additions and 0 deletions

30
rfc/README.md Normal file
View File

@@ -0,0 +1,30 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# 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` |

57
rfc/template.md Normal file
View File

@@ -0,0 +1,57 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# RFC-[number]: [Title]
## Proposers
- @<proposer1 github username>
- @<proposer2 github username>
## Approvers
- @<approver1 github username>
- @<approver2 github username>
## Status
JIRA: <link to umbrella 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 its 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?.