This is an automated email from the ASF dual-hosted git repository.
hulee pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/helix.wiki.git
The following commit(s) were added to refs/heads/master by this push:
new 8b0e3ae Updated Pull Request Description Template (markdown)
8b0e3ae is described below
commit 8b0e3aedc4527ca60d4743415f3835f554187e27
Author: Hunter Lee <[email protected]>
AuthorDate: Wed Feb 26 10:53:40 2020 -0800
Updated Pull Request Description Template (markdown)
---
Pull-Request-Description-Template.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Pull-Request-Description-Template.md
b/Pull-Request-Description-Template.md
index e00d877..259a574 100644
--- a/Pull-Request-Description-Template.md
+++ b/Pull-Request-Description-Template.md
@@ -25,7 +25,7 @@ Copy the following markdown and paste it into your Pull
Request's description. N
### Commits
-- [ ] My commits all reference appropriate Apache Helix GitHub issues in their
subject lines, and I have squashed multiple commits if they address the same
issue. In addition, my commits follow the guidelines from "[How to write a good
git commit message](http://chris.beams.io/posts/git-commit/)":
+- [ ] My commits all reference appropriate Apache Helix GitHub issues in their
subject lines. In addition, my commits follow the guidelines from "[How to
write a good git commit message](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
@@ -33,7 +33,7 @@ Copy the following markdown and paste it into your Pull
Request's description. N
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
-### Documentation
+### Documentation (Optional)
- [ ] In case of new functionality, my PR adds documentation in the following
wiki page:
@@ -41,12 +41,12 @@ Copy the following markdown and paste it into your Pull
Request's description. N
### Code Quality
-- [ ] My diff has been formatted using helix-style.xml
+- [ ] My diff has been formatted using helix-style.xml
(helix-style-intellij.xml if IntelliJ IDE is used)
```
# Pull Request Title and Description Template
-The following is the Pull Request description template every Pull Request
should follow. This serves as a reminder for commit quality as well as clear
acknowledgement from the contributors.
+The following is the Pull Request description template every Pull Request
should include. This serves as a reminder for contributors. Project maintainers
with merge privileges must review these items prior to merging them into master.
### Issues
@@ -80,7 +80,7 @@ The following is the Pull Request description template every
Pull Request should
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
-### Documentation
+### Documentation (Optional)
- [ ] In case of new functionality, my PR adds documentation in the following
wiki page:
