template-baseline

Shared baseline GitHub Repository Template for the VKS Platform App Engineering team (vks-app-eng-maintainers @ vmware-labs). First release: baseline-v1.0.0.

This is the source-of-truth baseline that every team template inherits — the common structure, CI, security hooks, docs-as-code setup, and AI-agent files. Language templates (template-python, template-go, …) and the GitOps workload template (template-gitops-argocd) layer their idiomatic files on top of this baseline.

What you get out of the box

Capability	Files
Prow CI (Kubernetes-native)	.prow.yaml, OWNERS, OWNERS_ALIASES
Secret scanning (mandatory)	.pre-commit-config.yaml (gitleaks + TruffleHog), .gitleaks.toml
AI agentic, from the start	AGENTS.md, SKILLS.md, CLAUDE.md, .claude/
Docs-as-code (Hugo + Docsy)	docs/
OCI image build	Containerfile (Dockerfile-compatible), .containerignore
Repo hygiene & meta	.github/, Makefile, CONTRIBUTING.md, SECURITY.md, LICENSE

Use this template

1. Confirm you are a vmware-labs org member and on the vks-app-eng-maintainers team (see the onboarding one-pager — org membership is a prerequisite).

2. Click “Use this template” → create your new repository.

3. Bootstrap local tooling:

   pre-commit install          # enable gitleaks/TruffleHog + hygiene hooks
   make help                   # list standard targets
   make docs-serve             # preview the Docsy docs site locally

4. Replace the <PLACEHOLDER> tokens (org, team, repo name, owners) throughout.

Repository layout

See docs/content/en/architecture/_index.md for the annotated layout, or the onboarding one-pager §6.2.

Versioning & updates

The baseline is tagged with SemVer (baseline-vX.Y.Z). Improvements land here first and are propagated to variants and consumer repos via the baseline-sync automation (see the one-pager §6.8). This repo is currently at the version recorded in VERSION.

License

Licensed under the Apache License 2.0.