Skip to content

Commit 8e79fb8

Browse files
authored
Merge pull request #2 from smlx/update-readme
chore: update readme
2 parents d802857 + 2f735a9 commit 8e79fb8

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,20 @@ It adds basic PR building, dependabot integration, testing, coverage etc.
1111

1212
1. Copy the contents of this repo into a new repo.
1313
2. Rename `cmd/go-cli-github` and update the links at the top of the README. Send a PR for this change, and merge it once green.
14-
3. Protect the main branch with requirements on lint/test as desired.
15-
4. That's it.
14+
3. Go to repository Settings > General:
15+
* Disable wiki and projects
16+
* Allow only merge commits for Pull Requests
17+
* Allow auto-merge
18+
* Automatically delete head branches
19+
4. Go to repository Settings > Branches and add branch protection to `main`, and enable:
20+
* Require a PR before merging
21+
* Dismiss stale pull request approvals
22+
* Require status checks to pass before merging
23+
* Require branches to be up-to-date before merging.
24+
* Required status checks:
25+
* lint
26+
* commitlint
27+
* build
28+
* go-test
29+
* Include administrators
30+
5. That's it.

0 commit comments

Comments
 (0)