Skip to content

Commit 2aa660f

Browse files
[MINOR] Add a RFC template and folder (apache#3726)
1 parent f0585fa commit 2aa660f

File tree

2 files changed

+87
-0
lines changed

2 files changed

+87
-0
lines changed

rfc/README.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one or more
3+
contributor license agreements. See the NOTICE file distributed with
4+
this work for additional information regarding copyright ownership.
5+
The ASF licenses this file to You under the Apache License, Version 2.0
6+
(the "License"); you may not use this file except in compliance with
7+
the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
# RFCs
18+
- 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.
19+
- Status can be one of these values: `UNDER REVIEW` (or) `IN PROGRESS` (or) `ABANDONED` (or) `COMPLETED`.
20+
21+
The list of all RFCs can be found here.
22+
23+
> 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.
24+
25+
26+
| RFC Number | Title | Status |
27+
| ------------- | ------------- |------------- |
28+
| ... | ... | ... |
29+
| [34](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=188745980) | Hudi BigQuery Integration |`UNDER REVIEW` |
30+
| [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` |

rfc/template.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one or more
3+
contributor license agreements. See the NOTICE file distributed with
4+
this work for additional information regarding copyright ownership.
5+
The ASF licenses this file to You under the Apache License, Version 2.0
6+
(the "License"); you may not use this file except in compliance with
7+
the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
# RFC-[number]: [Title]
18+
19+
20+
21+
## Proposers
22+
23+
- @<proposer1 github username>
24+
- @<proposer2 github username>
25+
26+
## Approvers
27+
- @<approver1 github username>
28+
- @<approver2 github username>
29+
30+
## Status
31+
32+
JIRA: <link to umbrella JIRA>
33+
34+
> Please keep the status updated in `rfc/README.md`.
35+
36+
## Abstract
37+
38+
Describe the problem you are trying to solve and a brief description of why it’s needed
39+
40+
## Background
41+
Introduce any much background context which is relevant or necessary to understand the feature and design choices.
42+
43+
## Implementation
44+
Describe the new thing you want to do in appropriate detail, how it fits into the project architecture.
45+
Provide a detailed description of how you intend to implement this feature.This may be fairly extensive and have large subsections of its own.
46+
Or it may be a few sentences. Use judgement based on the scope of the change.
47+
48+
## Rollout/Adoption Plan
49+
50+
- What impact (if any) will there be on existing users?
51+
- If we are changing behavior how will we phase out the older behavior?
52+
- If we need special migration tools, describe them here.
53+
- When will we remove the existing behavior
54+
55+
## Test Plan
56+
57+
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?.

0 commit comments

Comments
 (0)