-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
[Dev] How about removing explanation as comment in pull request template? #45485
Comments
Thanks @kou, this sounds like a good improvement to me 👍 |
Prior to this, did we tend to get problematic pull requests? I'm curious why this was added originally. Generally, I'm +1 here though. |
FTR, it seems that there are 20 commits having the unintentional message.
|
How about counting PRs that have auto comment for invalid format PR such as #45487 (comment) ? https://github.com/apache/arrow/pulls?q=is%3Apr+%22Licensed+to+the+Apache+Software+Foundation%22+%22Thanks+for+opening+a+pull+request%22+ shows 1364 PRs. |
#15249 is the PR that introduced this pull request template. |
Thanks both of you. I'm +1 as-is but would like to see is retain the links to the contribution guides in the PR if we can. Something like, 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)
Please remove this line and the above text before creating your pull request. |
The discussion thread: https://lists.apache.org/thread/7l5ktppo9dfwro6zl10gj6yp5j35sgpb |
Will appreciate to work on it here, post everyone's opinions in the discussion. |
Based on the discussion, let's choose the idea #45485 (comment) suggested by @amoeba . |
### Rationale for this change It seems that the current comment based pull request template isn't read carefully. ### What changes are included in this PR? * Remove explanations as comments * Keep a basic introduction in the top as a normal text not a comment * Use normal texts not comments for breaking changes and critical fix ### Are these changes tested? No. ### Are there any user-facing changes? No. This is only for developers. * GitHub Issue: #45485 Authored-by: Sutou Kouhei <kou@clear-code.com> Signed-off-by: Raúl Cumplido <raulcumplido@gmail.com>
Issue resolved by pull request 45599 |
Thanks @kou |
Describe the enhancement requested
The current pull request template: https://raw.githubusercontent.com/apache/arrow/refs/heads/main/.github/pull_request_template.md
For example, the following part is "explanation as comment":
Why?
dev/merge_arrow_pr.py
, these comments are included in commit message. (Because most contributors don't remove them.)How about removing them entirely?
Or how about keeping them as normal texts not comments and contributors must remove them when they read?
Component(s)
Developer Tools
The text was updated successfully, but these errors were encountered: