Skip to main content

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

  1. A standard folder layout that scales across repo types.
  2. Four repo profiles (application, library, infra, data) with explicit Required / Expected / Optional / N/A doc requirements.
  3. A defined contract for the ai/ directory — four files that carry session-to-session context.
  4. MADR 3.0 ADRs with a defined lifecycle.
  5. RFCs for time-boxed technical investigations (separate from raw discovery intake).
  6. Lightweight conventions for docs/discovery/ — meeting notes, requirement drafts, use cases — with a traceability flow to durable docs.
  7. A PR template that asks the right questions about documentation, ADRs, AI context, and operational impact.
  8. A STANDARDS-CHECKLIST.md with a waiver mechanism so absences are explicit, not silent.
  9. 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:

  1. Copy docs/templates/ into your repo.
  2. Pick a profile (application | library | infra | data).
  3. Fill in docs/STANDARDS.md (declare profile + any deviations).
  4. Fill in docs/STANDARDS-CHECKLIST.md (check off what exists, waive what doesn't).
  5. Seed ai/*.md from docs/templates/ai-starters/.
  6. Adopt .github/pull_request_template.md and .github/workflows/repo-standards.yml.
  7. 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 00010006 under docs/decisions/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

repo_standards_kit-0.9.0.tar.gz (100.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

repo_standards_kit-0.9.0-py3-none-any.whl (99.1 kB view details)

Uploaded Python 3

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

Hashes for repo_standards_kit-0.9.0.tar.gz
Algorithm Hash digest
SHA256 419946d1ce77f8dad01c407f25f83352eca3f192ee880dde1e92140e17781193
MD5 79e1ffd26760f0a9bb989b9cae33ac34
BLAKE2b-256 e2a3e7110a3889a601bfd6ccb8e34d75794ec7b14109185c0a9770cd968780f9

See more details on using hashes here.

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

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file repo_standards_kit-0.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for repo_standards_kit-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b0d9e3eac0f56485baa5a436382c606c76e8e2f582201f90bb9ffa748a0eadf7
MD5 1e19d4fd44f9f970b37e1e2ff47e998c
BLAKE2b-256 0ca0a6d4d43dd711e36131d39377595c5bdd1d74eb014afd30c55d578011bec7

See more details on using hashes here.

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

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page