Skip to content

Commit 5feadfe

Browse files
committed
docs: update readme for repo, base
1 parent 6ecb384 commit 5feadfe

File tree

1 file changed

+2
-29
lines changed

1 file changed

+2
-29
lines changed

README.md

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,3 @@
1-
# template-repo
1+
# aws-multi-account
22

3-
[![CodeQL](https://github.com/mindbuttergold/template-repo/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/mindbuttergold/template-repo/actions/workflows/github-code-scanning/codeql) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/mindbuttergold/template-repo/badge)](https://scorecard.dev/viewer/?uri=github.com/mindbuttergold/template-repo) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10740/badge)](https://www.bestpractices.dev/projects/10740)
4-
5-
Template repo with foundational config and workflows applicable across all repository setups
6-
7-
## Included Components
8-
9-
This template repository provides the following components:
10-
- README.md
11-
- Minimal .gitignore
12-
- MIT OSS License
13-
- CODEOWNERS file
14-
- Semantic Release config file and Github Actions workflow
15-
- Automatically handles repository releases based on Conventional Commit standards
16-
- PR title validation Github Actions workflow
17-
- Ensures PR title complies with Conventional Commit standards for use with squash merging / semantic release automation
18-
- Custom PR thumbs up check Github Actions workflow
19-
- Checks all open PRs in the repo for thumbs up reactions from at least 5 community members, excluding the PR author
20-
- If 5+ thumbs up on PR, automatically adds "community-approved" label to PR
21-
- If "community-approved" label was previously added, but thumbs up reduced to below 5, it removes the label
22-
- Custom community approval label check
23-
- Checks if the "community-approved" label is present on the PR
24-
- Serves as a required check for PR mergeability
25-
26-
## Usage
27-
28-
Admin / maintainers of the mindbuttergold organization can use this template to create a new repository. The new repository will contain all of the files in this repository.
29-
30-
The only repo-specific changes that need to be made for the new repo are to this README. The badge URLs must be updated, and the openssf best practices self-certification process must be re-conducted for each repo.
3+
[![CodeQL](https://github.com/mindbuttergold/template-repo/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/mindbuttergold/aws-multi-account/actions/workflows/github-code-scanning/codeql) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/mindbuttergold/aws-multi-account/badge)](https://scorecard.dev/viewer/?uri=github.com/mindbuttergold/aws-multi-account) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10740/badge)](https://www.bestpractices.dev/projects/10740)

0 commit comments

Comments
 (0)