Skip to content

Commit 24f89b7

Browse files
mliesenbergmxm
authored andcommitted
FLINK-3529 Add template for pull requests
- link from CONTRIBUTING.md to PR template - add it to excluded file of rat plugin This closes apache#1729.
1 parent 142912b commit 24f89b7

File tree

3 files changed

+19
-1
lines changed

3 files changed

+19
-1
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ To make the process smooth for the project *committers* (those who review and ac
88

99
Please check out the [How to Contribute guide](http://flink.apache.org/how-to-contribute.html) to understand how contributions are made.
1010
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.
11-
11+
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.

PULL_REQUEST_TEMPLATE.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration.
2+
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).
3+
In addition to going through the list, please provide a meaningful description of your changes.
4+
5+
- [ ] General
6+
- The pull request references the related JIRA issue
7+
- The pull request addresses only one issue
8+
- Each commit in the PR has a meaningful commit message
9+
10+
- [ ] Documentation
11+
- Documentation has been added for new functionality
12+
- Old documentation affected by the pull request has been updated
13+
- JavaDoc for public methods has been added
14+
15+
- [ ] Tests & Build
16+
- Functionality added by the pull request is covered by tests
17+
- `mvn clean verify` has been executed successfully locally or a Travis build has passed

pom.xml

+1
Original file line numberDiff line numberDiff line change
@@ -843,6 +843,7 @@ under the License.
843843
<exclude>CONTRIBUTING.md</exclude>
844844
<exclude>CONTRIBUTORS</exclude>
845845
<exclude>DEPENDENCIES</exclude>
846+
<exclude>PULL_REQUEST_TEMPLATE.md</exclude>
846847
<!-- Build files -->
847848
<exclude>**/*.iml</exclude>
848849
<exclude>flink-quickstart/**/testArtifact/goal.txt</exclude>

0 commit comments

Comments
 (0)