You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@parquet.apache.org by zi...@apache.org on 2019/05/27 16:30:05 UTC

[parquet-mr] branch master updated: PARQUET-1579 Add Github PR template (#642)

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

zivanfi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/parquet-mr.git


The following commit(s) were added to refs/heads/master by this push:
     new 882cbf8  PARQUET-1579 Add Github PR template (#642)
882cbf8 is described below

commit 882cbf8a9ae347b321c2edb5902af544d9fb6242
Author: Fokko Driesprong <fo...@apache.org>
AuthorDate: Mon May 27 18:29:58 2019 +0200

    PARQUET-1579 Add Github PR template (#642)
---
 .github/PULL_REQUEST_TEMPLATE.md | 26 ++++++++++++++++++++++++++
 pom.xml                          |  1 +
 2 files changed, 27 insertions(+)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..010cdd1
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,26 @@
+Make sure you have checked _all_ steps below.
+
+### Jira
+
+- [ ] My PR addresses the following [Parquet Jira](https://issues.apache.org/jira/browse/PARQUET/) issues and references them in the PR title. For example, "PARQUET-1234: My Parquet PR"
+  - https://issues.apache.org/jira/browse/PARQUET-XXX
+  - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
+
+### Tests
+
+- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
+
+### Commits
+
+- [ ] My commits all reference Jira 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
+  1. Subject uses the imperative mood ("add", not "adding")
+  1. Body wraps at 72 characters
+  1. Body explains "what" and "why", not "how"
+
+### Documentation
+
+- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
+  - All the public functions and the classes in the PR contain Javadoc that explain what it does
diff --git a/pom.xml b/pom.xml
index 9db8c0c..0d52add 100644
--- a/pom.xml
+++ b/pom.xml
@@ -470,6 +470,7 @@
         <configuration>
           <consoleOutput>true</consoleOutput>
           <excludes>
+            <exclude>.github/PULL_REQUEST_TEMPLATE.md</exclude>
             <exclude>**/*.parquet</exclude>
             <exclude>**/*.avro</exclude>
             <exclude>**/*.json</exclude>