MapBase/source-sdk-2013-mapbase
1
0
Fork 0
mirror of https://github.com/mapbase-source/source-sdk-2013.git synced 2025-06-27 04:59:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated Reviewing Mapbase pull requests (markdown)

Blixibon 2023-12-17 23:16:05 -06:00
parent a4f1adf6f1
commit 089a46e96b
1 changed files with 1 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Reviewing-Mapbase-pull-requests.md

@ -118,16 +118,4 @@ You can do this regardless of whether you've made any comments on the lines them
---
## Merging a pull request (collaborators only)
Although anyone with a GitHub account can review, approve, and/or request changes to a pull request, collaborators with write permissions are the only ones with authority to merge them, and a PR must have an approving review from at least 2 collaborators in order to be merged.
If you are a collaborator with write permissions, then once a PR has been sufficiently reviewed and it is safe to merge it into the target branch, you should see an option to merge a pull request near the bottom of the page.
(picture of merge prompt)
This is the most (and possibly the only) dangerous part of the review process. Before merging, you can select a merge strategy to use. If you are familiar with Git, then you will most likely be familiar with these strategies. The other strategies mainly serve to keep the commit history clean, but they should only be used if the source branch will not be used further. If it will (or you're not sure), then you should use "Create a merge commit".
If you know that the source branch will not be used in the future, then you can either use "Squash and merge" to transform all of the commits into one commit on the target branch or "Rebase and merge" to add the commits to the target branch without creating a merge commit. This makes the commit history look cleaner than using a merge commit, but there are consequences of squashing or rebasing a branch which will merge the target branch back, so they should be used sparingly.
We may add a new checklist option to check the author's intent with the source branch in the future.
A section explaining how to merge pull requests as a collaborator will be added to this guide at a later time. For the time being, leave merges to Blixibon.