Agent skill

repo-structure-canonical-structure

Sub-skill of repo-structure: Canonical Structure (+1).

View SKILL.md on GitHub Repository
Stars 4
Forks 4

Install this agent skill to your Project

npx add-skill https://github.com/vamseeachanta/workspace-hub/tree/main/.claude/skills/_archive/workspace-hub/repo-structure/canonical-structure

SKILL.md

Canonical Structure (+1)

Canonical Structure

repo/
  src/
    <package_name>/        ← installed package root (snake_case)
      __init__.py          ← required at every level
      common/              ← cross-cutting utilities
      modules/             ← domain feature modules
        <domain>/
          __init__.py
          core.py          ← main logic
          utils.py         ← helpers
      cli/                 ← command-line entrypoints (if any)
  tests/
    <domain>/              ← mirrors src/<package>/<domain>/
      unit/
      integration/
      fixtures/
  docs/
  config/
  scripts/
  data/
  reports/                 ← gitignored (generated)
  pyproject.toml           ← required at repo root
  pytest.ini               ← required; must include pythonpath = src

Rules

  1. One package per src/ — src/ contains exactly src/<package_name>/. No other Python packages at src/other_package/ level.
  2. __init__.py required at every directory that is a Python package.
  3. pythonpath = src in pytest.ini — never rely on PYTHONPATH env variable for CI.
  4. Tests mirror src — tests/<domain>/ maps to src/<package>/<domain>/. Do NOT use tests/modules/<domain>/ wrapper — the modules/ level is redundant.
  5. No loose scripts at root — ad-hoc .py files at repo root belong in scripts/ or src/<package>/cli/ or src/<package>/tools/.

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

vamseeachanta/workspace-hub

gsd-complete-milestone

Archive completed milestone and prepare for next version

4 4
Explore
vamseeachanta/workspace-hub

gsd-reapply-patches

Reapply local modifications after a GSD update

4 4
Explore
vamseeachanta/workspace-hub

gsd-verify-work

Validate built features through conversational UAT

4 4
Explore
vamseeachanta/workspace-hub

gsd-thread

Manage persistent context threads for cross-session work

4 4
Explore
vamseeachanta/workspace-hub

clinical-trial-protocol

Generate clinical trial protocols for medical devices or drugs through a modular, waypoint-based architecture with research-only and full protocol modes.

4 4
Explore
vamseeachanta/workspace-hub

single-cell-rna-qc

Performs quality control on single-cell RNA-seq data (.h5ad or .h5 files) using scverse best practices with MAD-based filtering and comprehensive visualizations.

4 4
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results