Skip to content

tinmanworks-foundation/repo-template-base

Repository files navigation

Template baseline repository for doctrine-aligned projects with shared governance, documentation, and CI maturity contracts.

Status

  • Stage: Draft | Active | Stable | Deprecated
  • Owner:
  • License:
  • Visibility: Public | Private | Internal
  • Reason:
  • Promotion criteria to Public:

What This Project Is

  • A canonical base template for governance and documentation conventions.
  • A foundation for derived language/platform templates.

Why It Exists

  • Keep template maturity consistent across the template family.
  • Provide stable defaults for docs, policy, and repository hygiene.

Maturity Baseline

  • Shared doctrine context (AI_CONTEXT.md + docs/doctrine/*).
  • Core and advisory validation via tools/validate-template.sh.
  • Core-gated CI with non-blocking advisory checks.

Use This Template

  1. Click Use this template on GitHub to create a new repository.
  2. Rename package/module identifiers and update ownership metadata.
  3. Review .env.example and update environment configuration for your target project.
  4. Run validation and CI checks before first release.

Quickstart

Prerequisites

  • Bash shell
  • rg (ripgrep)

Run Validation

bash tools/validate-template.sh core
bash tools/validate-template.sh advisory

Repository Layout

  • docs/ project documentation and doctrine snapshot
  • examples/ runnable examples (recommended)
  • tools/ helper scripts
  • .github/ issue templates and CI workflows

Documentation

Validation

bash tools/validate-template.sh

Contributing

See CONTRIBUTING.md.

About

Base repository template providing documentation, governance, and structure for all projects.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages