Skip to content

GH-47899: [Dev] Add checklist to PR template #47916

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −0
Draft

GH-47899: [Dev] Add checklist to PR template #47916

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ Please remove this line and the above text before creating your pull request.

### Are there any user-facing changes?

### Checklist

- [ ] The PR's title follows existing conventions of the repository
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a link to the Contributing Overview in the beginning of the template, but some extra info about what the title should look like might be good? Maybe adding a link again (https://arrow.apache.org/docs/developers/overview.html#pull-request-and-review) or an example.

Because I find titles needing an update quite frequently.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link would be good.

- [ ] My code follows the general style and conventions of the codebase
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [ ] 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))

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

- [ ] I have performed a self-review of these changes
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added docstrings for any non-trivial APIs I have added
- [ ] I have run `pre-commit run --all` locally and it passed successfully
- [ ] New and existing tests pass locally with my changes

**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.)
Comment on lines 28 to 30
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you keep this in the "Are there any user-facing changes?" section?