repo-structure-canonical-structure
Sub-skill of repo-structure: Canonical Structure (+1).
Best use case
repo-structure-canonical-structure is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Sub-skill of repo-structure: Canonical Structure (+1).
Teams using repo-structure-canonical-structure should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/canonical-structure/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How repo-structure-canonical-structure Compares
| Feature / Agent | repo-structure-canonical-structure | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Sub-skill of repo-structure: Canonical Structure (+1).
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# 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/`.
---Related Skills
interactive-report-generator
Generate interactive HTML reports with Plotly visualizations from data analysis results. Supports dashboards, charts, and professional styling.
data-validation-reporter
Generate interactive validation reports with quality scoring, missing data analysis, and type checking. Combines Pandas validation, Plotly visualization, and YAML configuration for comprehensive data quality reporting.
repo-ecosystem-hygiene
Interpret the daily read-only repo ecosystem hygiene audit and route remediation through approved workflows.
orcaflex-reporting-fixture-proof-pattern
Build and extend fixture-backed OrcaFlex reporting proof paths in digitalmodel using stable metadata baselines, normalized HTML snapshots, and reusable reporting test helpers.
repo-sync
Smart repository synchronization across workspace-hub ecosystem — diagnoses and fixes pull failures (detached HEAD, diverged branches, uncommitted changes)
repo-structure
Canonical source layout, test mirroring, root cleanliness, gitignore, docs classification, and committed artifact rules for all workspace-hub tier-1 repos. Consult before creating directories or files in any submodule.
repo-portfolio-steering
Generate a one-page portfolio steering report for workspace-hub. Use when the user invokes /repo-portfolio-steering, asks about harness vs engineering balance, wants a portfolio health check, or asks which repos to fund next. Reports on portfolio steering, GTM readiness, and provider activity balance.
repo-mission-portfolio-audit
Audit the workspace-hub repo portfolio to extract each repo's mission, identify documentation gaps, and prioritize a plan/approval sequence with explicit LLM-wiki weighting for future issue triage.
mixed-ops-vs-repo-fix-plan-boundary
Plan mixed operational-vs-repo remediation issues by proving live-state classification first, then only proposing code changes for confirmed repo-owned failure paths.
repo-separation-for-sensitive-data
Architecture pattern for splitting confidential data and reusable algorithms across repos
nested-git-repo-stash-safety
How to safely stash changes in a parent repo containing dirty nested git repositories
multi-repo-sync-diagnosis-repair
Diagnose and repair failed pulls across multi-repo ecosystems with stale locks, submodule conflicts, and untracked files