From 7723ea82c4b895da80f1cd6b312ab9ca94b5d4ac Mon Sep 17 00:00:00 2001 From: Alexander Neben Date: Tue, 11 Jun 2024 12:57:48 -0700 Subject: [PATCH] SERVER-91397 Improve PR template and override criteria (#23334) GitOrigin-RevId: 18f78af685dc56c2bbf0f08a5d4ed96cbf4467e7 --- .github/PULL_REQUEST_TEMPLATE/README.md | 2 ++ .github/pull_request_template.md | 21 +-------------------- docs/owners/merging.md | 6 ++---- 3 files changed, 5 insertions(+), 24 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/README.md b/.github/PULL_REQUEST_TEMPLATE/README.md index 75e8a170fd3..55a4097d45b 100644 --- a/.github/PULL_REQUEST_TEMPLATE/README.md +++ b/.github/PULL_REQUEST_TEMPLATE/README.md @@ -6,6 +6,8 @@ These custom templates can be used for example, by individual teams to have a cu Read more in [Github's docs](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository) +If you update the default PR template, you also need to update the commit metadata in github branch rulesets. + # How To Use This Folder To create a custom template, create a new markdown file in this folder. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 663ade82555..4372a97e2d3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,20 +1 @@ -# Issue - - - -# Description - - - -# Testing - -- [ ] - - +Anything in this description will be included in the commit message. Replace or delete this text before merging. Add links to testing in the comments of the PR. diff --git a/docs/owners/merging.md b/docs/owners/merging.md index 7639c9de8fb..cf3b06b4d93 100644 --- a/docs/owners/merging.md +++ b/docs/owners/merging.md @@ -1,7 +1,5 @@ # Merging -## Merging into master - ### Standard Merge If you have some changes locally that you want to merge into the mongodb repo, you must create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request?tool=webui#creating-the-pull-request). Once the pull request is created you must get approval from an [owner](owners_format.md) of the files changed. If the files changed have no owner then you must get approval from one other engineer. Once you have gotten approval you will see a green merge button which, when pressed, will merge your code. @@ -14,9 +12,9 @@ If you have changes that fall into one of the following categories you can get a 2. You are reverting a change that has caused a failure in mainline. 3. You are making a large scale change. For example, renaming a prolific typo in the codebase, applying formatting, applying a generated fix, etc... -To get an override you must get approval from any module owner or a member of 10gen/mongo-break-glass (module owners should be members of 10gen/mongo-break-glass). +To get an override you must get approval from any module owner or a member of [10gen/mongo-break-glass](https://mana.corp.mongodbgov.com/resources/664e9bed3d7d150379d3e0d0) (module owners should be members of 10gen/mongo-break-glass). -Once you have the approvals needed, the person providing the override must wait to a merge queue patch pass with the changes and a base merged within 8 hours (should be verified by the overrider). The overrider will then click the checkbox and the red "Merge pull request" button.![override_image](override_image.png) +Once you have the approvals needed, the person providing the override must wait for a merge-queue patch to complete without failures and a base merged within 8 hours (should be verified by the overrider). The overrider will then click the checkbox and the red "Merge pull request" button.![override_image](override_image.png) This will skip the merge queue and force all merges in the queue to restart since the base was updated. ## Merging into an older branch (backports)