Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH-2939: Update PULL_REQUEST_TEMPLATE #2940

Merged
merged 2 commits into from
Jul 8, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 61 additions & 24 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,70 @@
Make sure you have checked _all_ steps below.

### Issue
<!--
Thanks for opening a pull request!
If this is your first pull request you can find detailed information on how
Fokko marked this conversation as resolved.
Show resolved Hide resolved
to contribute here: [Contributing Overview](https://parquet.apache.org/docs/contribution-guidelines/contributing)

- [ ] My PR addresses the following [GitHub issues](https://github.com/apache/parquet-java/issues) and references
them in the PR title. For example, "GH-1234: My Parquet PR"
- https://github.com/apache/parquet-java/issues/1234
- 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).
If this is not a minor PR, could you open an issue for this pull request on GitHub? https://github.com/apache/parquet-java/issues/new/choose
Fokko marked this conversation as resolved.
Show resolved Hide resolved

### Tests
Opening GitHub issues ahead of time contributes to the [Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Parquet-Java project.
Fokko marked this conversation as resolved.
Show resolved Hide resolved

- [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
Then could you also rename the pull request title in the following format?
Fokko marked this conversation as resolved.
Show resolved Hide resolved

### Commits
GH-${GITHUB_ISSUE_ID}: ${SUMMARY}

- [ ] My commits all reference 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 GitHub 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"
or

### Style
- [ ] My contribution adheres to the code style guidelines and Spotless passes.
- To apply the necessary changes, run `mvn spotless:apply -Pvector-plugins`
MINOR: ${SUMMARY}

### 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
### Rationale for this change

<!--
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
-->

### What changes are included in this PR?

<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
-->

### Are these changes tested?

<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code

If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
-->

### Are there any user-facing changes?

<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->

<!--
Please uncomment the line below (and provide explanation) if 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).
-->
<!-- **This PR adds new dependency.** -->

<!--
If there are any breaking changes to public APIs, please uncomment the line below and explain which changes are breaking.
-->
<!-- **This PR includes breaking changes to public APIs.** -->

<!--
Fokko marked this conversation as resolved.
Show resolved Hide resolved
Please uncomment the line below (and provide explanation) if the changes fix either (a) a security vulnerability, (b) a bug that caused incorrect or invalid data to be produced, or (c) a bug that causes a crash (even when the API contract is upheld). We use this to highlight fixes to issues that may affect users without their knowledge. For this reason, fixing bugs that cause errors don't count, since those are usually obvious.
-->
<!-- **This PR contains a "Critical Fix".** -->

<!--
Please uncomment the line below and replace ${GITHUB_ISSUE_ID} with the actual Github issue id so it can automatically close the issue when this PR is merged.
For more information please refer to https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
-->
<!-- closes #${GITHUB_ISSUE_ID} -->