Skip to content

Commit 0876679

Browse files
authoredJul 8, 2024
apacheGH-2939: Update PULL_REQUEST_TEMPLATE (apache#2940)
* apacheGH-2939: Update PULL_REQUEST_TEMPLATE * remove lengthy comments
1 parent e6d7728 commit 0876679

File tree

1 file changed

+21
-24
lines changed

1 file changed

+21
-24
lines changed
 

‎.github/PULL_REQUEST_TEMPLATE.md

+21-24
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,30 @@
1-
Make sure you have checked _all_ steps below.
1+
<!--
2+
Thanks for opening a pull request!
23
3-
### Issue
4+
If you're new to Parquet-Java, information on how to contribute can be found here: https://parquet.apache.org/docs/contribution-guidelines/contributing
45
5-
- [ ] My PR addresses the following [GitHub issues](https://github.com/apache/parquet-java/issues) and references
6-
them in the PR title. For example, "GH-1234: My Parquet PR"
7-
- https://github.com/apache/parquet-java/issues/1234
8-
- In case you are adding a dependency, check if the license complies with
9-
the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
6+
Please open a GitHub issue for this pull request: https://github.com/apache/parquet-java/issues/new/choose
7+
and format pull request title as below:
108
11-
### Tests
9+
GH-${GITHUB_ISSUE_ID}: ${SUMMARY}
1210
13-
- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
11+
or simply use the title below if it is a minor issue:
1412
15-
### Commits
13+
MINOR: ${SUMMARY}
1614
17-
- [ ] My commits all reference GitHub issues in their subject lines. In addition, my commits follow the guidelines
18-
from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
19-
1. Subject is separated from body by a blank line
20-
1. Subject is limited to 50 characters (not including GitHub issue reference)
21-
1. Subject does not end with a period
22-
1. Subject uses the imperative mood ("add", not "adding")
23-
1. Body wraps at 72 characters
24-
1. Body explains "what" and "why", not "how"
15+
-->
2516

26-
### Style
27-
- [ ] My contribution adheres to the code style guidelines and Spotless passes.
28-
- To apply the necessary changes, run `mvn spotless:apply -Pvector-plugins`
17+
### Rationale for this change
2918

30-
### Documentation
3119

32-
- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
33-
- All the public functions and the classes in the PR contain Javadoc that explain what it does
20+
### What changes are included in this PR?
21+
22+
23+
### Are these changes tested?
24+
25+
26+
### Are there any user-facing changes?
27+
28+
29+
<!-- Please uncomment the line below and replace ${GITHUB_ISSUE_ID} with the actual Github issue id. -->
30+
<!-- Closes #${GITHUB_ISSUE_ID} -->

0 commit comments

Comments
 (0)
Please sign in to comment.