This is an automated email from the ASF dual-hosted git repository. github-merge-queue[bot] pushed a commit to branch gh-readonly-queue/main/pr-11211-1514ea4579340f680b460739d5a96fab38b1314c in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
commit 2c337d8fa918e87999a6738167a0ddab881c6016 Author: Jeffrey Vo <[email protected]> AuthorDate: Fri Oct 2 08:16:38 2026 +0000 chore: update PR template (#11211) some parts were outdated (like the changelog note), and wanted to enhance based on behaviour ive been seeing in some PRs --- .github/pull_request_template.md | 42 ++++++++++++++++++++++++++++++---------- 1 file changed, 32 insertions(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7daafd5b38..c3720f6cc7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,22 +1,32 @@ # Which issue does this PR close? <!-- -We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. +It is not necessary to raise an issue, but it is encouraged if it is a non-trivial +enhancement/bug. + +If this PR relates to an existing issue, but does not fully resolve it, please change +the wording below from "Closes #NNN" to "Relates to #NNN" or "Part of #NNN" to avoid +false closing an issue. --> -- Closes #NNN. +- Closes #NNN # 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. +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. + +Please try to explain the problem you are trying to solve in terms of the user-visible +behavior, rather than the implementation. --> # 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. +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? @@ -26,15 +36,27 @@ 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)? +If tests are not included in your PR, please explain why (for example, are they +covered by existing tests, if so identify these tests)? -If this PR claims a performance improvement, please include evidence such as benchmark results. +If this PR claims a performance improvement, please include evidence such as +benchmark results. + +DO NOT simply paste a list of commands ran to verify the code; this is what our +CI is for and it pollutes the PR. ONLY explain if testing was included with this +PR, or why it wasn't. --> -# Are there any user-facing changes? +# Are there any significant user-facing changes? <!-- -If there are user-facing changes then we may require documentation to be updated before approving the PR. +Significant user-facing changes include: +- Breaking public API change +- Significant change to existing functionality (e.g. function returns something different) + +These need to be explicitly called out to ensure we have proper documentation if +required and to ensure we follow proper semantic versioning. -If there are any breaking changes to public APIs, please call them out. +DO NOT restate the changes of this PR; if a bug was fixed and already explained +above, we don't need this to be restated as a user-facing change. -->
