Skip to content

docs: explain Contract-Driven Development for component interfaces - #46

Closed
mnriem wants to merge 2 commits into
mainfrom
mnriem-contract-driven-development-docs
Closed

mnriem wants to merge 2 commits into
mainfrom
mnriem-contract-driven-development-docs

Conversation

@mnriem

@mnriem mnriem commented Sep 17, 2026

Copy link
Copy Markdown
Owner

Description

Fixes github#4609.

Add a self-contained Contract-Driven Development guide and link it from the SDD overview, monorepo guide, and documentation navigation.

The guide starts with interacting components and their externally observable obligations, not repository coordination. It covers defining missing contracts, one authoritative owner with consumer participation, direct references within a repository, pinned artifacts or synchronized copies across repositories, verification on both sides, and deliberate compatible evolution.

Includes standalone website/orders/inventory and control-plane/data-plane/integration-tests examples. No new CLI commands, core template changes, mandatory umbrella repository, dependency resolver, or release orchestrator.

Context and credit

Testing

  • Tested locally with uv run specify --help
  • Ran existing tests with uv sync && uv run pytest
  • Tested with a sample project (if applicable)

The CLI and sample-project checks above are not applicable to this documentation-only change; the Python suite was not run.

Passed on this branch:

  • npx --no-install markdownlint-cli2 docs/guides/contract-driven-development.md docs/guides/monorepo.md docs/concepts/sdd.md
  • git diff --check upstream/main...HEAD
  • Added relative-link checks, navigation entry uniqueness, and DocFX content inclusion.
  • Exact-content comparison with the source documentation commit and confirmation that the diff against upstream contains only four documentation files.

A full DocFX build and rendered-site visual inspection were not performed.

AI Disclosure

  • I did not use AI assistance for this contribution
  • I did use AI assistance (fill in the disclosure below)

AI disclosure: GitHub Copilot using GPT-6 Astra (model ID: gpt-6-astra) drafted, revised, reviewed, checked, and committed this documentation on behalf of @mnriem in the source interactive session. The user supplied the architectural direction and requested refinements; the documentation edits and checks were performed autonomously by the agent, without a claim of line-by-line human review. In this follow-up session, the same agent/model transferred the existing documentation commit unchanged onto current upstream main, reran focused documentation checks, pushed the branch, and prepared this submission at the user's request. Reasoning-effort configuration is not exposed to the agent. AI involvement is documentation and PR-text generation only, not production code changes.

KSchlobohm and others added 2 commits September 17, 2026 09:12
Regenerate the three community submission locks with Copilot CLI 1.0.80 and the compiler defaults. Preserve submission instructions and file allowlists, and cover runtime compatibility and output guards.

Assisted-by: GitHub Copilot (model: GPT-6 Astra, autonomous)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…ithub#4609)

Document authoritative ownership, versioned sharing, bilateral verification, and compatible evolution across component boundaries. Add self-contained checkout and control-plane examples and link the guide from the documentation site.

Assisted-by: GitHub Copilot (model: gpt-6-astra, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@mnriem mnriem closed this Sep 17, 2026
@mnriem
mnriem deleted the mnriem-contract-driven-development-docs branch September 21, 2026 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Contract-Driven Development for component interfaces

2 participants