@@ -39,18 +39,43 @@ make repro
3939
4040``` text
4141.
42- |- .github/workflows/
43- |- docs/
44- |- examples/
45- |- scripts/
46- |- src/drc_python_template/
47- |- tests/
48- |- AGENTS.md
49- |- CONTRIBUTING.md
50- |- Makefile
51- `- pyproject.toml
42+ |-- .github/
43+ | `-- workflows/
44+ |-- docs/
45+ |-- examples/
46+ |-- scripts/
47+ |-- src/
48+ | `-- drc_python_template/
49+ |-- tests/
50+ |-- .gitignore
51+ |-- .pre-commit-config.yaml
52+ |-- .python-version
53+ |-- AGENTS.md
54+ |-- CONTRIBUTING.md
55+ |-- LICENSE
56+ |-- Makefile
57+ |-- README.md
58+ |-- pyproject.toml
59+ `-- uv.lock
5260```
5361
62+ - ` .github/workflows/ ` contains the GitHub Actions definitions for CI and docs publishing.
63+ - ` docs/ ` contains the Sphinx source files for the package documentation.
64+ - ` examples/ ` contains small runnable scripts that demonstrate the public API.
65+ - ` scripts/ ` contains repository maintenance and validation helpers used by ` make ` .
66+ - ` src/drc_python_template/ ` contains the installable Python package code.
67+ - ` tests/ ` contains the pytest suite that protects the public behavior.
68+ - ` .gitignore ` defines which local caches, virtualenvs, and build outputs stay untracked.
69+ - ` .pre-commit-config.yaml ` provides an optional pre-commit hook that runs the local CI gate.
70+ - ` .python-version ` pins the preferred reproducible Python interpreter version.
71+ - ` AGENTS.md ` documents repository-specific guidance for coding agents and contributors.
72+ - ` CONTRIBUTING.md ` documents the human contributor workflow and quality checks.
73+ - ` LICENSE ` contains the repository's software license.
74+ - ` Makefile ` provides the standard local commands for setup, linting, testing, docs, and releases.
75+ - ` README.md ` is the top-level overview and quickstart guide for the repository.
76+ - ` pyproject.toml ` defines package metadata, dependencies, and tool configuration.
77+ - ` uv.lock ` pins the reproducible dependency graph used by ` make repro ` .
78+
5479## Customizing The Template
5580
5681Before using this as a real package, update:
0 commit comments