Hi, Can we improve our PR template?
Related issue: https://github.com/apache/arrow/issues/45485 We're using comments in our PR template to explain our contribution guides. See <!-- ... --> parts in [1]. Comments are visible only in PR description edit view. [1] https://raw.githubusercontent.com/apache/arrow/refs/heads/main/.github/pull_request_template.md I feel that this approach is inconvenient because: 1. Some (many?) contributors don't read them (Our PR title checker detects many invalid formatted PRs: 1366 PRs [2]) 2. They are when I edit PR description (Because we use PR description when we merge a PR.) 3. If a commiter doesn't use dev/merge_arrow_pr.py, these comments are included in commit message. (In general, this doesn't happen.) [2] https://github.com/apache/arrow/pulls?q=is%3Apr+%22Licensed+to+the+Apache+Software+Foundation%22+%22Thanks+for+opening+a+pull+request%22+ What do you think about comments in our PR template? Here are some ideas to improve our PR template: 1. Remove them entirely: ---- ### Rationale for this change ### What changes are included in this PR? ### Are these changes tested? ### Are there any user-facing changes? ---- 2. Keep minimal notes as a normal text not a comment 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. ### Rationale for this change ### What changes are included in this PR? ### Are these changes tested? ### Are there any user-facing changes? ---- FYI: If we (1) don't use comments in our PR template, (2) embed "fix GH-XXX" in a PR description and (3) add a helper GitHub Actions job that assign milestone, we may be able to remove dev/merge_arrow_pr.py and use the merge button in a PR. Thanks, -- kou
