Skip to content

updateREADME #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
garretpatten merged 2 commits into from
Nov 15, 2025
Merged

updateREADME #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5c7c8c
updateREADME
garretpatten Nov 15, 2025
8dcdb38
md linter errors
garretpatten Nov 15, 2025
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
26 changes: 18 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Template Repository

A comprehensive template repository for starting new projects with pre-configured development tools, code quality checks, and security scanning.
A comprehensive template repository for starting new projects with
pre-configured development tools, code quality checks, and security scanning.

## Contents

Expand All @@ -9,7 +10,8 @@ This template includes the following components:
### Code Formatting

- **Prettier** - Configured with consistent formatting rules (`.prettierrc`)
- **Prettier ignore patterns** (`.prettierignore`) - Excludes build artifacts and dependencies
- **Prettier ignore patterns** (`.prettierignore`) - Excludes build artifacts
and dependencies

### VS Code Configuration

Expand All @@ -18,7 +20,9 @@ This template includes the following components:

### GitHub Workflows

- **Quality Checks** (`.github/workflows/quality-checks.yaml`) - Calls reusable workflow from `garretpatten/quality-checks` repository to run various linters and formatters:
- **Quality Checks** (`.github/workflows/quality-checks.yaml`) - Calls
reusable workflow from `garretpatten/quality-checks` repository to run
various linters and formatters:
- Actionlint
- ESLint
- Hadolint
Expand All @@ -30,19 +34,25 @@ This template includes the following components:
- Taplo
- Yamllint

- **Semgrep Scan** (`.github/workflows/semgrep-scan.yaml`) - Security and code quality scanning using Semgrep
- **Trufflehog Scan** (`.github/workflows/trufflehog-scan.yaml`) - Secret scanning to detect exposed credentials
- **Security Checks** (`.github/workflows/security-checks.yaml`) - Calls
reusable workflow from `garretpatten/security-checks` repository to run
security scans:
- Semgrep - Security and code quality scanning
- Trufflehog - Secret scanning to detect exposed credentials

### GitHub Configuration

- **CODEOWNERS** - Sets repository owner for code review requirements
- **Dependabot** (`.github/dependabot.yaml`) - Automated dependency updates for GitHub Actions
- **Dependabot** (`.github/dependabot.yaml`) - Automated dependency updates
for GitHub Actions
- **Issue Template** (`.github/issue_template.md`) - Standardized issue creation
- **Pull Request Template** (`.github/pull_request_template.md`) - Standardized PR creation
- **Pull Request Template** (`.github/pull_request_template.md`) -
Standardized PR creation

### Other Files

- **`.gitignore`** - Comprehensive ignore patterns for Node.js, build artifacts, and common development files
- **`.gitignore`** - Comprehensive ignore patterns for Node.js, build
artifacts, and common development files
- **`.truffleignore`** - Patterns to exclude from Trufflehog secret scanning
- **`LICENSE`** - License file for the repository
- **`package.json`** - Node.js package configuration with Prettier as a dev dependency
Expand Down