AgentSkillsCN

flatten-repo-architecture

设计并维护 flatten-repo 包架构（包括 src 目录结构、模块边界、CLI 组合、设置与日志集成，以及打包元数据的配置）。

SKILL.md
--- frontmatter
name: flatten-repo-architecture
description: Design and maintain the flatten-repo package architecture (src layout, module boundaries, CLI composition, settings/logging integration, and packaging metadata wiring).

Flatten Repo Architecture

Scope

Use this skill when changing package structure, responsibilities between modules, CLI entry points, or release-related metadata wiring.

Rules

  1. •Keep production code under src/flatten_repo/.
  2. •Keep modules cohesive:
    • •cli.py: argument parsing and orchestration only.
    • •settings.py: runtime configuration model.
    • •logging.py: logging setup only.
    • •config.py: enums, constants, shared models.
    • •file_manipulation.py: filesystem/git/content processing.
    • •output_construction.py: markdown/jsonl rendering and chunking.
  3. •Avoid importing heavy runtime logic in __init__.py.
  4. •Keep CLI entry point at flatten_repo.cli:main.
  5. •Preserve src/ packaging and wheel/sdist config in pyproject.toml.
  6. •Keep package version consistent between pyproject.toml and src/flatten_repo/__init__.py.
  7. •Keep project.urls, classifiers, and script metadata current for PyPI consumers.

Validation

Run:

  • •uv run pytest -m unit
  • •uv run python -m flatten_repo.cli --help
  • •uv run python -m flatten_repo.cli --version