Files
portfolio-hub/.github/templates/interface-contract.md
T
genichin 362b008940 Squashed '.vendor/stage-pilot/' changes from 7ab085e..551777b
551777b feat: add interface contract and data model baseline support to bootstrap-baseline
f17e086 feat: add bootstrap seed file support to bootstrap-baseline skill
be85338 feat: introduce lightweight change path, change-req skill, and release feedback loop
949bb40 docs(skill): new-discovery 병렬 Discovery 및 active-cycle 처리 규칙 강화
7f96130 docs: fix draft-req skill template paths
94b1445 diff --git a/.github/skills/draft-batch-design/SKILL.md b/.github/skills/draft-batch-design/SKILL.md index 5f87d00..944e075 100644 --- a/.github/skills/draft-batch-design/SKILL.md +++ b/.github/skills/draft-batch-design/SKILL.md @@ -1,6 +1,6 @@  ---  name: draft-batch-design -description: "Use when: drafting the design document for an existing batch, running /draft-batch-design with a BAT ID, filling docs/batches/<BAT_ID>/design.md, or recording architecture and interface decisions before implementation." +description: "Use when: drafting the design document for an existing batch, running /draft-batch-design with a BAT ID, filling docs/batches/<BAT_ID>/design.md, recording architecture and interface decisions before implementation, or planning updates to docs/project-structure.md and docs/runtime-flows.md."  argument-hint: "예: bat-001 또는 docs/batches/bat-001_20260424_scaffold"  user-invocable: true  --- @@ -9,27 +9,43 @@ user-invocable: true
d1ce3ce 프로세스 완전 변경

git-subtree-dir: .vendor/stage-pilot
git-subtree-split: 551777bc7009ee133fbaab1267ca324f1dc3c6bb
2026-04-30 13:00:41 +00:00

3.0 KiB

{{PROJECT_NAME}} Interface Contract

  • Baseline Mode: {{BASELINE_MODE:declared|observed|mixed}}
  • Baseline Seed: {{BASELINE_SEED_PATH:.stagepilot/bootstrap/baseline.yaml}}
  • Status: draft | confirmed
  • Owner: {{OWNER_OR_TEAM}}
  • Last Updated (KST): {{UPDATED_AT_KST}}
  • Source Discovery / Batch: {{SOURCE_REF}}
  • Primary Runtime: {{PRIMARY_RUNTIME:cli|api-service|web-app|worker|library|mixed|other}}

Project Summary

  • {{PROJECT_SUMMARY:one-sentence summary of the project}}

Primary Domain

  • {{PRIMARY_DOMAIN:short domain phrase or undecided}}

Purpose

  • This document captures the approved external and cross-boundary interface contracts for the project.
  • It is a cross-cutting reference for REQ drafting, batch design, implementation, verification, and handoff.

Scope

  • Covers externally visible APIs, CLI surfaces, events, files, or batch I/O contracts.
  • Does not duplicate full business requirements already owned by REQ documents.
  • Does not replace low-level code references or generated API artifacts.

Interface Summary

{{INTERFACE_SUMMARY_BULLETS:- - :: }}

Interface: {{INTERFACE_NAME_1:primary interface name}}

  • Type: {{INTERFACE_TYPE_1:http-api|cli|event|file|internal-service|other}}
  • Consumers / Producers: {{INTERFACE_ACTORS_1:who calls or receives it}}
  • Purpose: {{INTERFACE_PURPOSE_1:what this interface exists to do}}
  • Stability: {{INTERFACE_STABILITY_1:experimental|internal|stable}}

Inputs

{{INTERFACE_INPUTS_1:- :: }}

Outputs

{{INTERFACE_OUTPUTS_1:- :: }}

Error Contract

{{INTERFACE_ERRORS_1:- :: }}

Compatibility Rules

{{INTERFACE_COMPATIBILITY_1:- }}

Interface: {{INTERFACE_NAME_2:secondary interface name}}

  • Type: {{INTERFACE_TYPE_2:http-api|cli|event|file|internal-service|other}}
  • Consumers / Producers: {{INTERFACE_ACTORS_2:who calls or receives it}}
  • Purpose: {{INTERFACE_PURPOSE_2:what this interface exists to do}}
  • Stability: {{INTERFACE_STABILITY_2:experimental|internal|stable}}

Inputs

{{INTERFACE_INPUTS_2:- :: }}

Outputs

{{INTERFACE_OUTPUTS_2:- :: }}

Error Contract

{{INTERFACE_ERRORS_2:- :: }}

Compatibility Rules

{{INTERFACE_COMPATIBILITY_2:- }}

Shared Constraints

{{INTERFACE_SHARED_CONSTRAINTS_BULLETS:- - <authentication, timeout, idempotency, or size constraint>}}

Current Gaps / Planned Changes

{{INTERFACE_CURRENT_GAPS_BULLETS:- - }}

Update Triggers

  • Update this document when an externally visible API, event, CLI, or file contract changes.
  • Update this document when a batch changes compatibility, validation, or error behavior.
  • Update this document when a new external consumer or producer is introduced.

Change Log

{{CHANGE_LOG_BULLETS:- - }}