You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by gi...@apache.org on 2026/08/30 15:10:18 UTC

(datafusion) 01/01: docs: Clarify the testing section in GitHub PR Template (#24798)

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-24798-74f4dd6fe42806cd6131628cacfdb8316234f825
in repository https://gitbox.apache.org/repos/asf/datafusion.git

commit 9b051564a1437bc00ad7210034938f51b65fcd93
Author: Yongting You <20...@gmail.com>
AuthorDate: Sun Aug 30 15:09:53 2026 +0000

    docs: Clarify the testing section in GitHub PR Template (#24798)
    
    ## 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. For example
    `Closes #123` indicates that this PR will close issue #123.
    -->
    
    - Closes #.
    
    ## 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.
    
    Please explain the problem you are trying to solve in terms of the
    user-visible
    behavior, rather than the implementation.
    
    For example, "The code in `foo.rs` doesn't handle nulls" is a symptom of
    the
    implementation. "COUNT(DISTINCT) returns wrong results when the column
    contains
    nulls" is the user-visible problem.
    -->
    
    I often notice the below testing section is interpreted as 'did you run
    `cargo test`'. This PR tries to clarify it.
    
    ## 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.
    
    If there are any breaking changes to public APIs, please add the `api
    change` label.
    -->
---
 .github/pull_request_template.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 01a44953e8..f3c069f5d9 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -26,14 +26,18 @@ nulls" is the user-visible problem.
 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?
+## What is the testing strategy for this PR?
 
 <!--
 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)?
+Briefly describe how this PR is tested, and point to the specific tests you added. For example: 'This new feature is covered by the `sqllogictest` cases added in `foo.slt`'.
+
+If this PR does not add tests, explain why. For example, if the change is already covered by existing tests, please mention it.
+
+You should also check the `codecov` bot reply on this PR to confirm the changed code is exercised.
 -->
 
 ## Are there any user-facing changes?


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org