docs: add a diagram explaining how branch-protector works (#382)

guardian · Oct 18, 2023 · 48cd035 · 48cd035
1 parent f370095
commit 48cd035
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/img/branchprotector.png b/docs/img/branchprotector.png
diff --git a/packages/branch-protector/README.md b/packages/branch-protector/README.md
@@ -15,3 +15,7 @@ It will apply the following protections:
 
 - All status checks must pass before merging
 - Approval is required from one person who must be a member of at least one of the teams enumerated in the `admin_slugs`
+
+### Architecture of branch protector
+
+![Architecture diagram](../../docs/img/branchprotector.png)