Skip to content

Home

Jump to bottom
KP edited this page Oct 24, 2025 · 1 revision

Welcome to Spec-Bootstrap

This wiki provides a high-level overview of the Spec-Bootstrap template repository.

Overview

Spec-Bootstrap is a ready-to-use GitHub template that integrates the [Spec ‑Kit](https://github.com/) framework into any project. It sets up a comprehensive CI/CD pipeline with branch-based workflows, automated pull request creation, and daily verification.

Key Features

  • Spec-Kit Integration – Includes .specify directory with constitution.md, spec.md, and plan.md to drive spec-driven development.
  • Branch Architecture – Structured branches (main, dev, test, stage, prod, pages) each with a dedicated purpose and workflow.
  • Automated CI/CD – Workflows for each branch run tests and validations. Auto-PR workflows synchronize changes between branches after successful runs.
  • Daily Verification – A scheduled workflow that checks the health of all branch workflows and opens an issue if any run fails.
  • Documentation & Templates – Issue templates, README badges, and wiki pages to help you get started quickly.

Getting Started

To use this template for your own project:

  1. Click Use this template on the repository’s home page.
  2. Once your new repository is created, update the .specify/spec.md and .specify/plan.md files to reflect your project's requirements and architecture.
  3. Develop new features in the dev branch. Push commits to trigger the Dev Branch Workflow.
  4. When all checks pass, auto‑PR workflows will propose merges to test, stage, and prod branches. Review and merge these PRs as appropriate.
  5. Use the pages branch to host your documentation via GitHub Pages.

Branch Roles

  • main – Stable baseline; production-ready code.
  • dev – Active development and experimentation; initial feature work.
  • test – Integration testing and validation; merges from dev are tested here.
  • stage – Pre-production staging; final checks before production.
  • prod – Production release branch used for deployments.
  • pages – Documentation and GitHub Pages site.

Additional Resources

  • Visit the repository’s Discussions tab for announcements and Q&A.
  • Check the Actions tab to monitor workflow runs and status badges.
  • Review the issue templates under .github/ISSUE_TEMPLATE for bug reports and feature requests.

Happy building!

Clone this wiki locally