Team Repository Standards Kit — adopt and stay current with the standards via a single CLI.
Project description
Team Repository Standards Kit
A versioned, opinionated set of documentation standards and templates that any repository on the team can adopt. The kit's goal is to keep documentation lean, durable, and useful for both humans and AI-assisted development workflows.
- Status: Slice 1 — Templates + Standards Content
- Version: 0.1.0
- Authoritative spec:
docs/STANDARDS.md - Agent contract:
AGENTS.md
What this kit gives you
- A standard folder layout that scales across repo types.
- Four repo profiles (application, library, infra, data) with explicit Required / Expected / Optional / N/A doc requirements.
- A defined contract for the
ai/directory — four files that carry session-to-session context. - MADR 3.0 ADRs with a defined lifecycle.
- RFCs for time-boxed technical investigations (separate from raw discovery intake).
- Lightweight conventions for
docs/discovery/— meeting notes, requirement drafts, use cases — with a traceability flow to durable docs. - A PR template that asks the right questions about documentation, ADRs, AI context, and operational impact.
- A
STANDARDS-CHECKLIST.mdwith a waiver mechanism so absences are explicit, not silent. - A v1 CI check that enforces the structural minimum.
The information flow
docs/discovery/ → docs/rfcs/ → docs/decisions/ → docs/0X-*.md
(raw intake) (investigated) (decided) (synthesized & durable)
meetings, reqs, time-boxed, MADR 3.0 ADRs, PRD, architecture,
use case drafts spawn-or-abandon immutable runbook, etc.
How to adopt the kit in a new repo
This is documented in docs/STANDARDS.md. Short version:
- Copy
docs/templates/into your repo. - Pick a profile (
application|library|infra|data). - Fill in
docs/STANDARDS.md(declare profile + any deviations). - Fill in
docs/STANDARDS-CHECKLIST.md(check off what exists, waive what doesn't). - Seed
ai/*.mdfromdocs/templates/ai-starters/. - Adopt
.github/pull_request_template.mdand.github/workflows/repo-standards.yml. - Point your AI tools at
AGENTS.md,CLAUDE.md, and.github/copilot-instructions.md.
A Skill that automates this is queued in Slice 2.
Documentation philosophy
Keep documentation lean but scalable. Add durable docs when they improve onboarding, implementation, review, operations, traceability, or decision quality. Do not create documents only because a structure exists — that's why the kit uses Required / Expected / Optional rather than a single rigid required-doc list.
Roadmap
| Slice | Scope | Status |
|---|---|---|
| 1 | Templates + standards content (this slice) | In progress |
| 2 | AI Skills + Hooks (Claude Code, Copilot) | Designed only |
| 3 | Distribution mechanism (template repo vs. plugin vs. copy script) | Not started |
| 4 | Deeper CI enforcement (linting, freshness, link checking) | Not started |
The full design rationale for Slice 1 is captured in ADRs 0001–0006 under docs/decisions/.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file repo_standards_kit-0.9.0.tar.gz.
File metadata
- Download URL: repo_standards_kit-0.9.0.tar.gz
- Upload date:
- Size: 100.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
419946d1ce77f8dad01c407f25f83352eca3f192ee880dde1e92140e17781193
|
|
| MD5 |
79e1ffd26760f0a9bb989b9cae33ac34
|
|
| BLAKE2b-256 |
e2a3e7110a3889a601bfd6ccb8e34d75794ec7b14109185c0a9770cd968780f9
|
Provenance
The following attestation bundles were made for repo_standards_kit-0.9.0.tar.gz:
Publisher:
release.yml on swanson-dev/Repo-Standards-Kit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
repo_standards_kit-0.9.0.tar.gz -
Subject digest:
419946d1ce77f8dad01c407f25f83352eca3f192ee880dde1e92140e17781193 - Sigstore transparency entry: 1685532459
- Sigstore integration time:
-
Permalink:
swanson-dev/Repo-Standards-Kit@a2d85a68f36817997d15d6ca5113dbd53f8b2a51 -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/swanson-dev
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@a2d85a68f36817997d15d6ca5113dbd53f8b2a51 -
Trigger Event:
push
-
Statement type:
File details
Details for the file repo_standards_kit-0.9.0-py3-none-any.whl.
File metadata
- Download URL: repo_standards_kit-0.9.0-py3-none-any.whl
- Upload date:
- Size: 99.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b0d9e3eac0f56485baa5a436382c606c76e8e2f582201f90bb9ffa748a0eadf7
|
|
| MD5 |
1e19d4fd44f9f970b37e1e2ff47e998c
|
|
| BLAKE2b-256 |
0ca0a6d4d43dd711e36131d39377595c5bdd1d74eb014afd30c55d578011bec7
|
Provenance
The following attestation bundles were made for repo_standards_kit-0.9.0-py3-none-any.whl:
Publisher:
release.yml on swanson-dev/Repo-Standards-Kit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
repo_standards_kit-0.9.0-py3-none-any.whl -
Subject digest:
b0d9e3eac0f56485baa5a436382c606c76e8e2f582201f90bb9ffa748a0eadf7 - Sigstore transparency entry: 1685532609
- Sigstore integration time:
-
Permalink:
swanson-dev/Repo-Standards-Kit@a2d85a68f36817997d15d6ca5113dbd53f8b2a51 -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/swanson-dev
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@a2d85a68f36817997d15d6ca5113dbd53f8b2a51 -
Trigger Event:
push
-
Statement type: