-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[MINOR] Add PR description validation on documentation updates #10799
[MINOR] Add PR description validation on documentation updates #10799
Conversation
c3ceee9
to
8ccbab2
Compare
8ccbab2
to
1982318
Compare
Hmm, most of the PRs does not need update for doc, is it reasonable to by default do all the validations? And the |
User needs to just add |
@danny0405 I updated the template to be more instructive so user knows to put "N/A" if no docs update is needed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1, but I still think it is too strict for force update for the doc part.
We can experiment with this. This will be a good reminder for people to think about docs. We still have features of which the docs is missing. |
"Java CI / validate-source", "Update Pr Compliance / run-tests", and "validate pr / validate-pr" pass which are suffucient for the tooling changes. There is no change to the production code. Merging this now. |
Change Logs
As above, to make PR description validation strict.
No information in the "Documentation Update" section in the PR description will trigger PR validation failure:
Impact
As above.
Risk level
none
Documentation Update
none
Contributor's checklist