Skip to content

Template Quality

Leonard Ramminger edited this page Aug 22, 2026 · 1 revision

Template Quality

Checklist before publishing a template.

Automated checks

tempify validate <id>    # manifest, questions, files
tempify lint <id>        # style & conventions
tempify inspect <id>     # show merged manifest
tempify test <id>        # snapshot fixtures

Manifest

  • id unique and stable (no renames without migration)
  • Semver in version - see Versioning & Reapply
  • description short and clear
  • output.path sensible (usually {{ project_slug }})

Questions

  • Sensible defaults and slugify for slugs
  • validate for namespaces, paths, licenses
  • sensitive = true for tokens/secrets
  • No empty groups in order

Files

  • .pbt only where variables are needed
  • No secrets in files/
  • .env only for template defaults, not user secrets

Hooks

  • Hooks idempotent where possible (re-render scenarios)
  • No writing outside build root
  • Short exec calls; respect timeout

Includes

  • file_conflicts explicit for intentional overrides
  • drop_paths for removed base files
  • Avoid cycles

Documentation

  • README in generated project explains next steps
  • Tags/category when distributed via ReqPack

See also

Template Tests · Example Catalog

Clone this wiki locally