@keelcore/standards
v0.11.5
Published
Engineering standards for keelcore projects — coding, CI, and bash.
Maintainers
Readme
keelcore/standards
Engineering standards for keelcore projects. Single source of truth for coding, CI, and bash. Consumed by AI coding tools (Claude, Cursor, Copilot) and human contributors alike.
Governance
| File | Scope | | ------------------------------------------------------------ | --------------------------------------------------------------------- | | governance/coding.md | All code edits — scope control, reviewability, safety | | governance/ci.md | CI workflows and scripts — supply chain, coverage, permissions | | governance/bash.md | Bash scripts — portability, structure, logging | | governance/platform.md | Platform architecture — governance process, DNS, TLS, WAF, networking | | governance/observability.md | Metrics, logging, tracing, alerting | | governance/security.md | IAM, encryption, key management, data classification | | governance/devsecops.md | Repo controls, release integrity, scanning gates, supply chain | | governance/runtime.md | Containers, orchestration, deployment, compliance | | governance/api-management.md | API design, versioning, rate limiting, quotas, gateway |
Consumption
Submodule (default, language-agnostic)
git submodule add [email protected]:keelcore/standards .standards
git submodule update --init --recursiveReference governance from your tool adapters via relative paths (.standards/governance/coding.md).
Update to latest:
git submodule update --remote .standards
git add .standards && git commit -m "chore: update standards"Go
go get github.com/keelcore/standards/goAdd to your repo:
//go:generate go run github.com/keelcore/standards/go/cmd/materialize .standardsThen run go generate ./... to extract governance files to .standards/ (gitignore this directory).
Node
npm install @keelcore/standardsGovernance files are available under node_modules/@keelcore/standards/governance/.
Python
pip install keelcore-standardsTool Adapters
Copy the relevant adapter to your repo and adjust paths if needed.
| Tool | Adapter | | -------------- | ------------------------------------------------------------------------------------ | | Claude Code | adapters/claude/CLAUDE.md | | Cursor | adapters/cursor/ | | GitHub Copilot | adapters/copilot/copilot-instructions.md |
Bootstrapping a New Repository
Paste-ready prompts that drive an AI coding agent through the full standards bootstrap: submodule + governance-mandated
scripts/ + canonical Makefile + BATS
- pre-commit. Each prompt encodes the human-in-the-loop contract (stage, do not commit).
| Agent | Prompt | | ----------- | -------------------------------------------------------------------------- | | Claude Code | adapters/claude/bootstrap_prompt.md |
Architecture Decision Records
ADRs documenting standards design decisions live in docs/adr/.
New ADRs use the template at docs/adr/0000-template.md.
| ADR | Decision | | ----------------------------------------------------------- | ------------------------------------------------------------ | | 0001 | Standards distributed as both submodule and language package | | 0002 | Code coverage baseline stored in repository | | 0003 | Architecture governance via DACI, RFC, and ARB | | 0004 | SPIFFE/SPIRE for workload identity | | 0005 | OpenTelemetry as the unified observability framework | | 0006 | OPA as the centralized authorization policy engine | | 0007 | Zero-downtime deployment via blue/green and canary | | 0008 | Rapid key rotation with a 5-minute platform SLA | | 0009 | GitOps as the declarative change management mechanism |
Versioning
Semantic versioning. Tags trigger publication to all package ecosystems simultaneously.
- Breaking changes (governance removals, renamed files): major version bump.
- New governance or expanded rules: minor version bump.
- Corrections, clarifications: patch version bump.
