2010YOUY01 commented on code in PR #24053:
URL: https://github.com/apache/datafusion/pull/24053#discussion_r3701051854
##########
.github/pull_request_template.md:
##########
@@ -11,12 +11,19 @@ We generally require a GitHub issue to be filed for all bug
fixes and enhancemen
<!--
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.
Review Comment:
```suggestion
A PR rationale should present a clear chain of reasoning. This helps other
contributors understand the intent end to end and engage at any step—for
example, by questioning an assumption or proposing an alternative approach.
When a PR description contains only low-level implementation details,
reviewers must reconstruct the original intent from the code changes themselves.
Here are the typical steps for describing a bug-fix PR:
1. What user-visible problem are you trying to solve?
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.
2. What is the high-level idea behind the fix?
3. (In the next 'changes' section) What are the key changes in the PR?
Highlight the changes that are central to the solution. For a large PR,
distinguish the core changes from follow-up or propagated fixes. This makes the
PR easier to navigate and review.
```
I think we have very similar ideas, but I tried to explain in more detail.
It may be a bit verbose, so perhaps we can make it more concise. 🤔 WDYT?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
