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) diff --git a/project_setup/branch-protection.md b/project_setup/branch-protection.md index b09dc4b..3df2a75 100644 --- a/project_setup/branch-protection.md +++ b/project_setup/branch-protection.md @@ -22,18 +22,19 @@ 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 - [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