Tools

trusty-git-analytics — documentation

Developer-productivity analytics CLI / DB. Crate name: tga (crates/trusty-git-analytics/). Walks local git repositories, classifies every commit into a work category via a multi-tier cascade, and emits per-author / per-week / DORA / velocity / quality reports.

This directory is the extended index for tga requirements, research, and user/developer documentation. Implemented behavior remains code-owned; start with the crate README and current CLI help.

Documentation map

Subdir	What's here
`spec/`	Historical PRD, architecture, and component baseline through tga v2.5.0.
`requirements/`	Detailed reference ported from the Python predecessor. Treat it as supporting documentation and verify changing CLI, schema, and taxonomy details against current code.
`developer/`	Contributor docs: architecture, developer guide, configuration reference, migration from Python, publishing.
`user/`	End-user docs: user guide.
`decisions/`	Crate-specific ADRs (Nygard format): SQLite tuning, performance hotspots, Bitbucket PR provider. Workspace-wide ADRs live in `docs/adr/`.
`regression-testing/`	Versioned performance/quality snapshots (`v{VERSION}-{DATE}.md`), the Rust-vs-Python `comparison.md`, and the methodology in `regression-testing/README.md`.
`research/`	Investigation and design documents: commit-effort scoping spec, per-engineer drilldown.
`sessions/`	Engineering-session narratives (none yet).

Where to start

Understanding the system? Start with the crate README, then use requirements/ for field-level background.
Using the CLI? user/user-guide.md.
Contributing? developer/developer-guide.md and developer/architecture.md.
Understanding a past decision? decisions/ (crate-specific) or docs/adr/ (workspace-wide).

Conventions

Subdirs follow the workspace documentation conventions described in the root CLAUDE.md. The spec/ set is a dated baseline; the requirements/ set is the detailed field-level source that originally mirrored the API contract of the gitflow-analytics Python predecessor and now serves as reference beneath spec/. research/ files are dated point-in-time investigations.