This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/main by this push:
new a49ce3e22f Add testing section to pull request template (#7749)
a49ce3e22f is described below
commit a49ce3e22f192cefeba8058230dd7588a4c47e31
Author: Andrew Lamb <[email protected]>
AuthorDate: Tue Jun 24 12:28:10 2025 -0400
Add testing section to pull request template (#7749)
# Which issue does this PR close?
N/A
# Rationale for this change
It is critical and generally required to add tests for any changes to
arrow-rs and it something we look for in our PR reviews. It would be
nice to remind people of this explicitly in the PR
# What changes are included in this PR?
1. Update the PR template to include a section on testing
2. Add a list marker (`-`) to the closes section which causes github to
render the name of the PR in markdown not just the number (see rationale
on https://github.com/apache/datafusion/pull/14507)
I copied the wording from DataFusion:
https://github.com/apache/datafusion/blob/b6c8cc57760686fffe4878e69c1be27e4d9f5e68/.github/pull_request_template.md?plain=1#L22
# Are there any user-facing changes?
A new section on PR descriptions
---
.github/pull_request_template.md | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index e999f505bc..49b34c6137 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -2,7 +2,7 @@
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.
-Closes #NNN.
+- Closes #NNN.
# Rationale for this change
@@ -13,6 +13,14 @@ Explaining clearly why changes are proposed helps reviewers
understand your chan
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.
