A portable, self‑contained framework for bootstrapping GitHub repositories with consistent governance, branch management, and CI/CD automation. Drop the .github/ directory into any project to instantly enable standardized workflows and policies.
-
Branch Strategy
mainfor productiondevelopfor integration- Convention‑based branches (
feat/*,chore/*,bug/*,docs/*,test/*, etc.) - Config‑driven prefix rules defined in
.github/branch_prefixes.json
-
Automated Workflows
nightly.yaml→ integrates all matching branches and runs testsstaging.yaml→ promotes selected prefixes into a staging branchrelease.yaml→ prepares release and hotfix branches for production- CI hooks for linting, testing, and build validation
-
Governance Files
- Issue and PR templates
CODEOWNERSfor clear responsibilityCONTRIBUTING.mdandSTYLE_GUIDE.md- Security and support policies
-
Config‑Driven Design
- JSON files define branch categories and rules
- Workflows consume these configs, ensuring consistency across environments
- Copy the
.github/directory into your repository. - Adjust
.github/branch_prefixes.jsonto match your branch naming conventions. - Push branches using the defined prefixes.
- Let the workflows run — nightly integration, staging promotion, and release preparation are all automated.
.github/
├── branch_prefixes.json
├── workflows/
│ ├── nightly.yaml
│ ├── staging.yaml
│ └── release.yaml
├── ISSUE_TEMPLATE.md
├── PULL_REQUEST_TEMPLATE.md
├── CODEOWNERS
├── CONTRIBUTING.md
├── STYLE_GUIDE.md
├── SECURITY.md
└── SUPPORT.md
The goal of github_scaffolding is to make repository setup copy‑and‑run ready. By standardizing governance and automation, teams can focus on building software while relying on consistent, battle‑tested workflows.
MIT License — free to use, modify, and distribute.