Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "Require conversation resolution before merging" to branch protection documentation #57

Merged
merged 3 commits into from
Aug 25, 2021
Merged

Add "Require conversation resolution before merging" to branch protection documentation #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a994f0
Add "Require conversation resolution before merging"
dav3r Aug 24, 2021
66e110f
Add some emphasis for clarity
jsf9k Aug 24, 2021
fd7af7b
Add a blurb about disabling squash merging
jsf9k Aug 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions project_setup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
15 changes: 8 additions & 7 deletions project_setup/branch-protection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
mcdonnnj marked this conversation as resolved.
Show resolved Hide resolved
- [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
Expand Down