Apache DataFusion SQL Query Engine
Docs: Update PR template to ask for user-visible rationale (#24053)
Andrew Lamb30eccb44e9a7
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.ymlindex 955e59d74d..62449afbbb 100644--- a/.github/ISSUE_TEMPLATE/feature_request.yml+++ b/.github/ISSUE_TEMPLATE/feature_request.yml@@ -9,7 +9,7 @@ body:description: Please describe what you are trying to do.placeholder: >A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]- (This section helps Arrow developers understand the context and *why* for this feature, in addition to the *what*)+ (This section helps DataFusion developers understand the context and *why* for this feature, in addition to the *what*)- type: textareaattributes:label: Describe the solution you'd likediff --git a/.github/pull_request_template.md b/.github/pull_request_template.mdindex 907d905239..01a44953e8 100644--- a/.github/pull_request_template.md+++ b/.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.-->## 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?@@ -33,8 +40,6 @@ If tests are not included in your PR, please explain why (for example, are they<!--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.-->