Skip to content

README.md

Latest commit

 

History

History
70 lines (51 loc) · 2.16 KB

README.md

File metadata and controls

70 lines (51 loc) · 2.16 KB

Github Scaffolding 🔥🔥🔥

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.

✨ Features

  • Branch Strategy

    • main for production
    • develop for 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 tests
    • staging.yaml → promotes selected prefixes into a staging branch
    • release.yaml → prepares release and hotfix branches for production
    • CI hooks for linting, testing, and build validation

  • Governance Files

    • Issue and PR templates
    • CODEOWNERS for clear responsibility
    • CONTRIBUTING.md and STYLE_GUIDE.md
    • Security and support policies

  • Config‑Driven Design

    • JSON files define branch categories and rules
    • Workflows consume these configs, ensuring consistency across environments

🚀 Getting Started

  1. Copy the .github/ directory into your repository.
  2. Adjust .github/branch_prefixes.json to match your branch naming conventions.
  3. Push branches using the defined prefixes.
  4. Let the workflows run — nightly integration, staging promotion, and release preparation are all automated.

📂 Structure

.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

🎯 Purpose

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.

📜 License

MIT License — free to use, modify, and distribute.