Skip to content
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

Closed
kou opened this issue Feb 10, 2025 · 11 comments
Closed

[Dev] How about removing explanation as comment in pull request template? #45485

kou opened this issue Feb 10, 2025 · 11 comments

Comments

@kou
Copy link
Member

kou commented Feb 10, 2025

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":

<!--
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/main/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}

-->

Why?

  • They are nuisance when I edit pull request description. (Because most contributors don't remove them.)
  • If a committer doesn't use dev/merge_arrow_pr.py, these comments are included in commit message. (Because most contributors don't remove them.)
  • I'm not sure whether contributors read them or not...

How about removing them entirely?

### Rationale for this change

### What changes are included in this PR?

### Are these changes tested?

### Are there any user-facing changes?

Or how about keeping them as normal texts not comments and contributors must remove them when they read?

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)

...

### Rationale for this change

...

Component(s)

Developer Tools

@raulcd
Copy link
Member

raulcd commented Feb 10, 2025

Thanks @kou, this sounds like a good improvement to me 👍

@amoeba
Copy link
Member

amoeba commented Feb 10, 2025

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.

@wgtmac
Copy link
Member

wgtmac commented Feb 11, 2025

FTR, it seems that there are 20 commits having the unintentional message.

~/Projects/arrow (main*) » git log | grep "Thanks for opening a pull request" | wc -l
      20

@kou
Copy link
Member Author

kou commented Feb 11, 2025

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.

@kou
Copy link
Member Author

kou commented Feb 11, 2025

#15249 is the PR that introduced this pull request template.

@amoeba
Copy link
Member

amoeba commented Feb 11, 2025

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.

@kou
Copy link
Member Author

kou commented Feb 17, 2025

@singh1203
Copy link

Will appreciate to work on it here, post everyone's opinions in the discussion.

@kou
Copy link
Member Author

kou commented Feb 21, 2025

Based on the discussion, let's choose the idea #45485 (comment) suggested by @amoeba .

kou added a commit to kou/arrow that referenced this issue Feb 21, 2025
raulcd pushed a commit that referenced this issue Feb 21, 2025
### 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>
@raulcd raulcd added this to the 20.0.0 milestone Feb 21, 2025
@raulcd
Copy link
Member

raulcd commented Feb 21, 2025

Issue resolved by pull request 45599
#45599

@raulcd raulcd closed this as completed Feb 21, 2025
@amoeba
Copy link
Member

amoeba commented Feb 21, 2025

Thanks @kou

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants