GH-47899: [Dev] Add checklist to PR template #47916
Conversation
|
|
github-actions
bot
added
Component: Documentation
awaiting review
github-actions
bot
added
awaiting committer review
.github/pull_request_template.md
Outdated
| **This PR includes breaking changes to public APIs.** (If there are any breaking changes to public APIs, please explain which changes are breaking. If not, you can remove this.) | ||
|
|
||
| **This PR contains a "Critical Fix".** (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), please provide explanation. If not, you can remove this.) |
There was a problem hiding this comment.
Could you keep this in the "Are there any user-facing changes?" section?
github-actions
bot
added
awaiting changes
amoeba
left a comment
amoeba
left a comment
There was a problem hiding this comment.
+1 to other comments others have made, left one change.
I'm +1 to this since you and others do the majority of the PR review and triage.
| ### Checklist | ||
|
|
||
| - [ ] The PR's title follows existing conventions of the repository | ||
| - [ ] My code follows the general style and conventions of the codebase |
There was a problem hiding this comment.
| - [ ] My code follows the general style and conventions of the codebase | |
| - [ ] My code follows the general style and conventions of the codebase ([C++](https://arrow.apache.org/docs/developers/cpp/development.html), [Python](https://arrow.apache.org/docs/developers/python/development.html)) |
There was a problem hiding this comment.
We don't have a good single reference for code style, but maybe linking directly to the C++ and Python development pages (which include style guidance) would be good? Generally, it'd be nice if as much of the contents of the PR template had links.
zanmato1984
left a comment
zanmato1984
left a comment
There was a problem hiding this comment.
Other than the two existing claims should be above the checklists as kou pointed out, lgtm.
pitrou
force-pushed
the
gh47899-checklist
branch
from
deef618 to
100b392
Compare
github-actions
bot
added
awaiting change review
|
I think I've addressed all review comments. There is a question however: do we keep the checklist in the PR message when merging? Do we delete it? |
|
Thanks @pitrou. I think it would be good to have the merge script remove the checklist on commit. The PR will always contain the checklist if we need to reference it for some reason later. Projects like brew and vcpkg don't include their checklist in the final commit. |
Ok, I will try to do this in this PR. |
5 participants
Rationale for this change
This is to try to steer contributors into submitting more polished PRs.