From 9a994f02556528a2e3a6259cadb42e0e0c759061 Mon Sep 17 00:00:00 2001 From: dav3r Date: Tue, 24 Aug 2021 10:27:59 -0400 Subject: [PATCH 1/3] Add "Require conversation resolution before merging" Also, clean up some indentation to match the indentation displayed on the branch protection page in the GitHub web GUI. --- project_setup/branch-protection.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/project_setup/branch-protection.md b/project_setup/branch-protection.md index b09dc4b..aaf622e 100644 --- a/project_setup/branch-protection.md +++ b/project_setup/branch-protection.md @@ -22,12 +22,13 @@ In `Settings`, go to the `Branches` entry and create a rule with the following: - [X] Require review from Code Owners - [X] Restrict who can dismiss pull request reviews - [X] Require status checks to pass before merging - - [X] Require branches to be up to date before merging - - There may be a list of status checks under this option. We require - passing status checks to merge, so all status checks should generally be - checked as required. - - Please note that the list of status checks will not fully populate in a - new repository until the first pull request (PR) has been created. + - [X] Require branches to be up to date before merging + - There may be a list of status checks under this option. We require + passing status checks to merge, so all status checks should generally be + checked as required. + - Please note that the list of status checks will not fully populate in a + new repository until the first pull request (PR) has been created. + - [X] Require conversation resolution before merging - [ ] Require signed commits - [ ] Require linear history - [X] Include administrators From 66e110f162f4bd1470253a69805c9465e02fc996 Mon Sep 17 00:00:00 2001 From: Jeremy Frasier Date: Tue, 24 Aug 2021 10:55:50 -0400 Subject: [PATCH 2/3] Add some emphasis for clarity --- project_setup/branch-protection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/project_setup/branch-protection.md b/project_setup/branch-protection.md index aaf622e..3df2a75 100644 --- a/project_setup/branch-protection.md +++ b/project_setup/branch-protection.md @@ -34,7 +34,7 @@ In `Settings`, go to the `Branches` entry and create a rule with the following: - [X] Include administrators - [X] Restrict who can push to matching branches - Note: this allows by default "People, teams or apps with push access", so -you likely don't have to make any changes under this entry +you likely don't have to make any changes _under_ this entry - Rules applied to everyone including administrators - [ ] Allow force pushes From fd7af7bfa43e987b1ec3571f1b5e55520220f2c5 Mon Sep 17 00:00:00 2001 From: Jeremy Frasier Date: Tue, 24 Aug 2021 11:37:59 -0400 Subject: [PATCH 3/3] Add a blurb about disabling squash merging --- project_setup/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/project_setup/README.md b/project_setup/README.md index ef9f87e..a747cb9 100644 --- a/project_setup/README.md +++ b/project_setup/README.md @@ -23,6 +23,7 @@ branch protection - [see our branch protection guide for details](branch-protect - [Selecting a skeleton](#selecting-a-skeleton) - [Cloning a selected skeleton](#cloning-a-selected-skeleton) - [Create and publish the GitHub repository](#create-and-publish-the-github-repository) +- [Disabling squash merging](#disabling-squash-merging) - [Set up your environment and pre-commit](#set-up-your-environment-and-pre-commit) - [Create an initial pull request](#create-an-initial-pull-request) - [Setting up branch protection](#setting-up-branch-protection) @@ -161,6 +162,12 @@ Next, publish your new repository to GitHub: git push --set-upstream origin develop ``` +## Disabling squash merging ## + +Click on the settings tab for your new repository and, in the +"Options" section, make sure that "Allow squash merging" is +_unchecked_. + ## Set up your environment and pre-commit ## Follow the instructions in [CONTRIBUTING.md on setting up pre-commit](../CONTRIBUTING.md#setting-up-pre-commit)