Skip to content
Merged
Changes from all commits
Commits
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
22 changes: 17 additions & 5 deletions configure_git_repository.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configure the Git Repository
# Configure the GitHub Repository

These are the suggested configurations for our GitHub repositories.
Please stick to it unless you have special needs.
Expand All @@ -9,15 +9,27 @@ Please stick to it unless you have special needs.
* Disable *Allow merge commits* and *Allow rebase merging*
* Allow auto-merge
* Automatically delete head branches
* Always suggest updating pull request branches
* Manage access
* Add *staff* team as a collaborator with Admin access
* Add *security* team as collaborator with Write access
* Branches
* Default branch: either `main` or `develop` depending on whether you want one or two environments.
* Add these rules for the two branches `develop` and `main`:
* Require pull request reviews before merging
* Require status checks to pass before merging (after you configured the CI add it to the required checks)
* Always suggest updating pull request branches
* Rules/Rulesets
* `develop`
* Enforcement status: `Active`
* Branch targeting criteria: `develop`
* Bypass list: add `Repository Admin` Role with *allow for pull requests only* option
* Restrict deletions
* Require linear history
* Require a pull request before merging
* Require status checks to pass
* Select `ci/semaphore/push`
* Block force pushes
* `main` (same as develop but...)
* Branch targeting criteria: `main`
* ❌ Require a pull request before merging
* ❌ Require status checks to pass

* Autolink references
* Add a new Autolink reference with:
Expand Down