GH-15249: [Documentation] Add PR template #15250
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # Which issue does this PR close? | ||
|
|
||
| <!-- | ||
| Thanks for opening a pull request! | ||
| If this is your first pull request you can find detailed information on how | ||
| to contribute here: | ||
| * [New Contributor's Guide](https://arrow.apache.org/docs/dev/developers/guide/step_by_step/pr_lifecycle.html#reviews-and-merge-of-the-pull-request) | ||
| * [Contributing Overview](https://arrow.apache.org/docs/dev/developers/overview.html) | ||
|
|
||
|
|
||
| If this is not a [minor PR](https://github.com/apache/arrow/blob/master/CONTRIBUTING.md#Minor-Fixes). Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose | ||
|
|
||
| Opening GitHub issues ahead of time contributes to the [Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Arrow project. | ||
|
|
||
| Then could you also rename the pull request title in the following format? | ||
|
|
||
| GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY} | ||
|
|
||
| or | ||
|
|
||
| MINOR: [${COMPONENT}] ${SUMMARY} | ||
|
|
||
| In the case of old issues on JIRA the title also supports: | ||
|
|
||
| ARROW-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY} | ||
| PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY} | ||
|
|
||
| --> | ||
| Closes # | ||
|
|
||
| # Rationale for this change | ||
|
Member
There was a problem hiding this comment. Seeing some first PRs with this, shall we use a smaller header? (eg
Contributor
There was a problem hiding this comment. Current header does looks too big IMO. |
||
|
|
||
| <!-- | ||
| 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. | ||
| --> | ||
|
|
||
| # 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 `breaking-change` label. | ||
| --> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we start to use this, that will get duplicated with the
* Closes ..that the bot adds. Do we then want to remove the bot action? (or some way to unify those? but since this is free form, it might be difficult to have the bot check it)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this line?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's also an option. As long as we still require an issue and ask it to be in the title, then this is indeed a bit redundant (and we could have a hidden comment explaining that it should be in the title)