Skip to content

Commit b0afe34

Browse files
alambkosiew
authored andcommitted
Docs: Update PR template to ask for user-visible rationale (apache#24053)
## Which issue does this PR close? - Part of apache#23839. ## Rationale for this change PR descriptions are most useful when they describe the problem being solved from the user's point of view, rather than describing what is wrong with some part of the code. ## What changes are included in this PR? 1. Update `.github/pull_request_template.md` to ask authors to explain the problem in terms of user-visible behavior (with an example), and to add the `api change` label for breaking public API changes. ## Are these changes tested? No tests needed: template-only change. ## Are there any user-facing changes? No changes to the code or documentation; contributors will see the updated templates when opening PRs and feature requests.
1 parent b947751 commit b0afe34

2 files changed

Lines changed: 9 additions & 4 deletions

File tree

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ body:
99
description: Please describe what you are trying to do.
1010
placeholder: >
1111
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12-
(This section helps Arrow developers understand the context and *why* for this feature, in addition to the *what*)
12+
(This section helps DataFusion developers understand the context and *why* for this feature, in addition to the *what*)
1313
- type: textarea
1414
attributes:
1515
label: Describe the solution you'd like

‎.github/pull_request_template.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,19 @@ We generally require a GitHub issue to be filed for all bug fixes and enhancemen
1111
<!--
1212
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
1313
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
14+
15+
Please explain the problem you are trying to solve in terms of the user-visible
16+
behavior, rather than the implementation.
17+
18+
For example, "The code in `foo.rs` doesn't handle nulls" is a symptom of the
19+
implementation. "COUNT(DISTINCT) returns wrong results when the column contains
20+
nulls" is the user-visible problem.
1421
-->
1522

1623
## What changes are included in this PR?
1724

1825
<!--
19-
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.
26+
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.
2027
-->
2128

2229
## Are these changes tested?
@@ -33,8 +40,6 @@ If tests are not included in your PR, please explain why (for example, are they
3340

3441
<!--
3542
If there are user-facing changes then we may require documentation to be updated before approving the PR.
36-
-->
3743
38-
<!--
3944
If there are any breaking changes to public APIs, please add the `api change` label.
4045
-->

0 commit comments

Comments
 (0)