Skip to content

Commit ca10086

Browse files
committed
Make docs update template instructive
1 parent 1982318 commit ca10086

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ _If medium or high, explain what verification was done to mitigate the risks._
1212

1313
### Documentation Update
1414

15-
_Describe any necessary documentation update if there is any new feature, config, or user-facing change_
15+
_Describe any necessary documentation update if there is any new feature, config, or user-facing change. If not, put "N/A"._
1616

1717
- _The config description must be updated if new configs are added or the default value of the configs are changed_
1818
- _Any new feature or user-facing change requires updating the Hudi website. Please create a Jira ticket, attach the

scripts/pr_compliance.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ def make_default_validator(body, debug=False):
402402
"### Documentation Update",
403403
{"_Describe any necessary documentation update if there is any new feature, config, or user-facing change_",
404404
"",
405-
"- _The config description must be updated if new configs are added or the default value of the configs are changed_",
405+
"- _The config description must be updated if new configs are added or the default value of the configs are changed. If not, put \"N/A\"._",
406406
"- _Any new feature or user-facing change requires updating the Hudi website. Please create a Jira ticket, attach the",
407407
" ticket number here and follow the [instruction](https://hudi.apache.org/contribute/developer-setup#website) to make",
408408
" changes to the website._"})
@@ -479,7 +479,7 @@ def test_body():
479479
"",
480480
"_Describe any necessary documentation update if there is any new feature, config, or user-facing change_",
481481
"",
482-
"- _The config description must be updated if new configs are added or the default value of the configs are changed_",
482+
"- _The config description must be updated if new configs are added or the default value of the configs are changed. If not, put \"N/A\"._",
483483
"- _Any new feature or user-facing change requires updating the Hudi website. Please create a Jira ticket, attach the",
484484
" ticket number here and follow the [instruction](https://hudi.apache.org/contribute/developer-setup#website) to make",
485485
" changes to the website._",

0 commit comments

Comments
 (0)