-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
GH-23: Add PR template #164
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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,60 @@ | ||
<!-- | ||
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-go/blob/main/CONTRIBUTING.md#Minor-Fixes). Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow-go/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} | ||
|
||
--> | ||
|
||
### 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. | ||
--> | ||
|
||
### 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 uncomment the line below and explain which changes are breaking. | ||
--> | ||
<!-- **This PR includes breaking changes to public APIs.** --> | ||
|
||
<!-- | ||
Please uncomment the line below (and provide explanation) if the changes fix either (a) a security vulnerability, (b) a bug that caused incorrect or invalid data to be produced, or (c) a bug that causes a crash (even when the API contract is upheld). We use this to highlight fixes to issues that may affect users without their knowledge. For this reason, fixing bugs that cause errors don't count, since those are usually obvious. | ||
--> | ||
<!-- **This PR contains a "Critical Fix".** --> |
This file contains 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
Oops, something went wrong.
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.
How about using raw text instead of comment text?
It seems that most developers don't remove comment in pull request template.
In apache/arrow, we remove comments in our merge script https://github.com/apache/arrow/blob/0c3206772051c52fe2e648623daaca2c4e71cb72/dev/merge_arrow_pr.py#L603-L604 but we don't use merge script in apache/arrow-go. So our commit history have many this comments...
If we use raw text instead of comment text, we can notice it before we use the merge button. We can remove needless texts before we merge.