You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hudi.apache.org by yu...@apache.org on 2022/09/29 01:42:47 UTC

[hudi] 06/17: [MINOR] Update PR template with documentation update (#6748)

This is an automated email from the ASF dual-hosted git repository.

yuzhaojing pushed a commit to branch release-0.12.1-rc1
in repository https://gitbox.apache.org/repos/asf/hudi.git

commit f1661187f55f0f5448ca39a29f2c63da9610a67c
Author: Y Ethan Guo <et...@gmail.com>
AuthorDate: Mon Sep 26 16:46:05 2022 -0700

    [MINOR] Update PR template with documentation update (#6748)
---
 .github/PULL_REQUEST_TEMPLATE.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 2ec8b61d05..17ad995a97 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -10,6 +10,15 @@ _Describe any public API or user-facing feature change or any performance impact
 
 _Choose one. If medium or high, explain what verification was done to mitigate the risks._
 
+### Documentation Update
+
+_Describe any necessary documentation update if there is any new feature, config, or user-facing change_
+
+- _The config description must be updated if new configs are added or the default value of the configs are changed_
+- _Any new feature or user-facing change requires updating the Hudi website. Please create a Jira ticket, attach the
+  ticket number here and follow the [instruction](https://hudi.apache.org/contribute/developer-setup#website) to make
+  changes to the website._
+
 ### Contributor's checklist
 
 - [ ] Read through [contributor's guide](https://hudi.apache.org/contribute/how-to-contribute)