You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by mx...@apache.org on 2016/04/06 10:07:05 UTC
flink git commit: FLINK-3529 Add template for pull requests
Repository: flink
Updated Branches:
refs/heads/master 142912b03 -> 24f89b7f1
FLINK-3529 Add template for pull requests
- link from CONTRIBUTING.md to PR template
- add it to excluded file of rat plugin
This closes #1729.
Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/24f89b7f
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/24f89b7f
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/24f89b7f
Branch: refs/heads/master
Commit: 24f89b7f1695ee095a2a161990bdcfd8c09283a5
Parents: 142912b
Author: Martin Liesenberg <ma...@gmail.com>
Authored: Sat Feb 27 15:51:45 2016 +0100
Committer: Maximilian Michels <mx...@apache.org>
Committed: Wed Apr 6 10:06:06 2016 +0200
----------------------------------------------------------------------
CONTRIBUTING.md | 2 +-
PULL_REQUEST_TEMPLATE.md | 17 +++++++++++++++++
pom.xml | 1 +
3 files changed, 19 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flink/blob/24f89b7f/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d08ed02..ac0b373 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,4 +8,4 @@ To make the process smooth for the project *committers* (those who review and ac
Please check out the [How to Contribute guide](http://flink.apache.org/how-to-contribute.html) to understand how contributions are made.
A detailed explanation can be found in our [Contribute Code Guide](http://flink.apache.org/contribute-code.html) which also contains a list of coding guidelines that you should follow.
-
+For pull requests, there is a [check list](PULL_REQUEST_TEMPLATE.md) with criteria taken from the How to Contribute Guide and the Coding Guidelines.
http://git-wip-us.apache.org/repos/asf/flink/blob/24f89b7f/PULL_REQUEST_TEMPLATE.md
----------------------------------------------------------------------
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..9721030
--- /dev/null
+++ b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,17 @@
+Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration.
+If your changes take all of the items into account, feel free to open your pull request. For more information and/or questions please refer to the [How To Contribute guide](http://flink.apache.org/how-to-contribute.html).
+In addition to going through the list, please provide a meaningful description of your changes.
+
+- [ ] General
+ - The pull request references the related JIRA issue
+ - The pull request addresses only one issue
+ - Each commit in the PR has a meaningful commit message
+
+- [ ] Documentation
+ - Documentation has been added for new functionality
+ - Old documentation affected by the pull request has been updated
+ - JavaDoc for public methods has been added
+
+- [ ] Tests & Build
+ - Functionality added by the pull request is covered by tests
+ - `mvn clean verify` has been executed successfully locally or a Travis build has passed
http://git-wip-us.apache.org/repos/asf/flink/blob/24f89b7f/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index ace4ec6..82b1567 100644
--- a/pom.xml
+++ b/pom.xml
@@ -843,6 +843,7 @@ under the License.
<exclude>CONTRIBUTING.md</exclude>
<exclude>CONTRIBUTORS</exclude>
<exclude>DEPENDENCIES</exclude>
+ <exclude>PULL_REQUEST_TEMPLATE.md</exclude>
<!-- Build files -->
<exclude>**/*.iml</exclude>
<exclude>flink-quickstart/**/testArtifact/goal.txt</exclude>