Skip to content

docs: add output and exit-code contract#82

Merged
CoderDeltaLAN merged 1 commit into
mainfrom
docs/add-output-exit-code-contract
Jun 18, 2026
Merged

docs: add output and exit-code contract#82
CoderDeltaLAN merged 1 commit into
mainfrom
docs/add-output-exit-code-contract

Conversation

@CoderDeltaLAN

Copy link
Copy Markdown
Owner

Summary

  • Expands docs/OUTPUTS.md into an initial CLI output contract and examples document.
  • Adds docs/EXIT-CODES.md for the current check and init exit-code behavior.
  • Links the new exit-code contract from README.
  • Records the documentation addition in CHANGELOG under Unreleased.

Scope

  • Documentation only.
  • No code changes.
  • No CI changes.
  • No dependency changes.
  • No release, tag, or PyPI changes.

Validation

  • Pre-stage checks passed.
  • Staged review passed.
  • Pre-push strong check passed.
  • 118 unit tests passed locally with dev dependencies.
  • Ruff passed.
  • Text hygiene passed.
  • Git whitespace checks passed.
  • CLI smoke confirmed expected exit codes for --version, check JSON, no-result check, and init without mode.

Risk

  • Low. Documentation-only contract clarification.
  • Main risk is over-promising stability; mitigated by explicit pre-v1.0 and non-security-guarantee wording.

Rollback

  • Revert this documentation-only commit.

@CoderDeltaLAN CoderDeltaLAN merged commit cf80256 into main Jun 18, 2026
1 check passed
@CoderDeltaLAN CoderDeltaLAN deleted the docs/add-output-exit-code-contract branch June 18, 2026 21:24
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.

1 participant