execution-types-contract

star 1

Keep execution engine changes aligned with stable public types (execution.py + types.py lockstep).

z3z1ma By z3z1ma schedule Updated 2/1/2026

name: execution-types-contract description: Keep execution engine changes aligned with stable public types (execution.py + types.py lockstep). license: MIT compatibility: opencode,claude metadata: created_at: "2026-02-01T04:33:04.956Z" updated_at: "2026-02-01T04:33:04.956Z" version: "1"

Purpose

When extending execution behavior, keep the public contract stable and import-safe.

When To Use

  • You change execution orchestration in src/vibe_piper/execution.py.
  • You also add/adjust public result/config types in src/vibe_piper/types.py.

Procedure

  • Decide what is "public API" vs. internal implementation.
  • Put public dataclasses/enums/protocols in src/vibe_piper/types.py.
  • Keep src/vibe_piper/execution.py focused on orchestration and flow.
  • Enforce a one-way dependency:
    • src/vibe_piper/execution.py may import from vibe_piper.types.
    • Avoid src/vibe_piper/types.py importing from vibe_piper.execution.
  • If you need type-only references that would create a cycle, use typing.TYPE_CHECKING and forward references.
  • Prefer narrow, explicit types (dataclasses/enums) over loose dicts for cross-module boundaries.

Manual notes

This section is preserved when the skill is updated. Put human notes, caveats, and exceptions here.

Install via CLI
npx skills add https://github.com/z3z1ma/vibe-pipe --skill execution-types-contract
Repository Details
star Stars 1
call_split Forks 0
navigation Branch main
article Path SKILL.md
More from Creator