Reranko05 commented on code in PR #55484: URL: https://github.com/apache/arrow/pull/55484#discussion_r4550681920
########## dev/README.md: ########## @@ -33,8 +33,34 @@ committer. ## How to Merge a Pull Request -Please don't merge PRs using the GitHub Web interface. Instead, run -the following command: +Use the "Squash and merge" button of the GitHub Web interface. Before +you merge, check that: + +* The pull request title is what you want as the commit title: + `GH-XXX: [Component] Title` or `MINOR: [Component] Title`. The + merge is blocked by the "PR Title" status of the Boring Cyborg app + (`.github/boring-cyborg.yml`) unless the title starts with `GH-XXX` + or `MINOR: `. +* The pull request description is what you want as the commit + message. Remove leftovers of the pull request template in the + merge dialog if needed. You must remove CI directives such as + `[skip ci]`: GitHub doesn't run the workflow below for a commit + with them and you need to close the issue manually. + +After the merge, the "Dev PR merged" GitHub Actions workflow assigns +the issue `GH-XXX` to the pull request author if it isn't assigned to +anyone, sets its milestone, closes it and comments which pull request +resolved the issue. The milestone is the milestone of the pull request: +set it before you merge if the pull request isn't released in the next +major release. If the pull request doesn't have a milestone, the +milestone of the issue is kept or the next major release is used. This Review Comment: This wording seems a little confusing to me. Would it be clearer to say: > The milestone is taken from the pull request. Set it before merging if the pull request isn't targeted for the next major release. If the pull request doesn't have a milestone, the existing issue milestone is retained; otherwise, the next major release is used. ########## docs/source/developers/overview.rst: ########## @@ -147,9 +146,9 @@ will merge the pull request. This is done with a cherry-pick individual patches onto a maintenance branch. Your pull request will appear in the GitHub interface to have been "merged". - In the commit message of that commit, the merge tool adds the pull request - description, a link back to the pull request, and attribution to the contributor - and any co-authors. + The commit message of that commit has the pull request description, a link + back to the pull request, and attribution to the contributor and any + co-authors. Review Comment: Same with this >The commit message includes the pull request description, a link to the pull request, and attribution to the contributor and any co-authors. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
