Skip to content

vosslab/starter-repo-template

Repository files navigation

starter_repo_template

Canonical bootstrap scaffolding for new Python repositories: ready-to-use repo policy docs, Python style rules, licensing boundaries, and pytest lint checks so projects start consistent before any project-specific code is added.

Only README.md and docs/CHANGELOG.md are intentionally repository-specific; every other file is designed to remain generic for downstream template users.

Documentation

Template layout

File location is the primary routing determinant. Files under docs/, tests/, and devel/ ship universally to every consumer repo. Files under templates/<type>/ (e.g., templates/typescript/, templates/python/, templates/rust/) ship only to repos of that type. Root-level files ship only when listed in ROOT_PROPAGATE_ALLOWLIST. Template-only tooling (e.g., tools/detect_repo_type.py) lives under tools/; it never propagates and is removed by reset_repo.py at consumer bootstrap. Propagation manifests live in meta/propagation/manifests.yaml (template-only; never ships to consumers).

Quick start

Bootstrap a fresh clone (sets project type + licenses, installs canonical files):

python3 reset_repo.py

The script runs an interactive interview: it asks for repo type (python, typescript, rust, swift, other, all), code and docs licenses, whether the project targets PyPI (python only), whether to stage changes, and whether to commit. CLI flags: --dry-run prints planned actions without writing; --config <file> runs non-interactively from a JSON answer file.

Run the fast test suite:

pytest tests/

Non-browser end-to-end tests live under tests/e2e/ per docs/E2E_TESTS.md when present; this repo does not currently ship any. Each runner is self-contained -- invoke them individually with bash tests/e2e/e2e_<name>.sh.

Run browser-driven Playwright tests (see templates/website/docs/PLAYWRIGHT_USAGE.md):

node tests/playwright/test_example.mjs

About

Starter repository template for my projects. Includes style guides, AGENTS.md, agent skills, and a small set of reusable development scripts to bootstrap new repos with consistent structure and workflow.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages