Skip to content

Commit

Permalink
doc: update branch protection info in readme (#206)
Browse files Browse the repository at this point in the history
  • Loading branch information
plastikfan committed Aug 3, 2023
1 parent b46f121 commit e59fbbd
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,11 @@ The following documents manual changes required. Manual checklist:

Unfortunately, github doesn't copy over the template project's settings to the client project, so these changes must be made manually:

+ `setup branch protection rules`: require pull request
+ `update project settings`: disable __Allow merge commits__ and __Allow squash merging__
Under `Protect matching branches`

+ `Require a pull request before merging`_ENABLE_
+ `Require linear history`_ENABLE_
+ `Do not allow bypassing the above settings`_ENABLE_

Of course, its up to the user what settings they use in their repo, these are just recommended as a matter of good practice.

Expand Down

0 comments on commit e59fbbd

Please sign in to comment.