Skip to content

Commit

Permalink
docs: remove redundant horizontal line separators
Browse files Browse the repository at this point in the history
  • Loading branch information
jtieri committed Jun 17, 2024
1 parent 942c9fb commit b674cb9
Showing 1 changed file with 3 additions and 37 deletions.
40 changes: 3 additions & 37 deletions docs/SETTINGS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Repository Settings

---

These are the default settings that should be configured in each repo, changes can be made as needed.
The settings described here should serve as a baseline, it is more important that there is some setting in place rather
than the exact settings being used across every repo.
Expand All @@ -11,8 +9,6 @@ project to run.

## General

---

### Default Branch
- Default branch should be `main`

Expand All @@ -32,8 +28,6 @@ project to run.

## Collaborators and teams

---

Every repo should have a team or set of teams configured in the `Manage Access` section. Ideally there should be
two teams where one team is given `Admin` access and the other team is given either `Maintain` or `Write` access.

Expand All @@ -42,8 +36,6 @@ they are automatically added as reviewers when a PR is opened. Read more on code

## Moderation options

---

### Interaction limits

Default settings should be alright here and can also be configured across the entire organization
Expand All @@ -59,8 +51,6 @@ Default settings should be alright here.

## Branches

---

A new branch protection rule should be created for the `main` branch. This rule should have the following settings:

- Enable require a pull request before merging
Expand All @@ -78,14 +68,10 @@ and/or other important branches that should not be merged into without proper re

## Tags

---

Default settings should be alright here.

## Rules

---

### Rulesets

Default settings should be alright here.
Expand All @@ -94,9 +80,7 @@ Default settings should be alright here.

Default settings should be alright here.

## Actions

---
## Actions

### General

Expand Down Expand Up @@ -124,43 +108,29 @@ Default settings should be alright here.

## Webhooks

---

Default settings should be alright here.

## Copilot

---

Default settings should be alright here.

## Environments

---

Default settings should be alright here.

## Codespaces

---

Default settings should be alright here.

## Pages

---

Default settings should be alright here.

## Custom Properties

---

Default settings should be alright here.

## Code security and analysis

---
## Code security and analysis

- Enable Private vulnerability reporting
- Enable dependency graph
Expand All @@ -181,13 +151,9 @@ Default settings should be alright here.

## Deploy keys

---

Default settings should be alright here and can be adjusted as needed.

## Secrets and variables

---
## Secrets and variables

Default settings should be alright here and can be adjusted as needed.

Expand Down

0 comments on commit b674cb9

Please sign in to comment.