Skip to content

feat: document code-review module scaffold#410

Merged
djm81 merged 2 commits intodevfrom
feature/code-review-01-module-scaffold
Mar 11, 2026
Merged

feat: document code-review module scaffold#410
djm81 merged 2 commits intodevfrom
feature/code-review-01-module-scaffold

Conversation

@djm81
Copy link
Collaborator

@djm81 djm81 commented Mar 11, 2026

Description

Adds the CLI-side version/docs/OpenSpec updates for the code-review-01-module-scaffold change and pairs with the modules PR that introduces the new specfact-code-review bundle scaffold.

Fixes #398

New Features #398

Contract References: No new core @icontract decorators were added in specfact-cli; the change wires and documents the new module surface.

Type of Change

Please check all that apply:

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🔒 Contract enforcement (adding/updating @icontract decorators)
  • 🧪 Test enhancement (scenario tests, property-based tests)
  • 🔧 Refactoring (code improvement without functionality change)

Contract-First Testing Evidence

Required for all changes affecting CLI commands or public APIs:

Contract Validation

  • Runtime contracts added/updated (@icontract decorators on public APIs)
  • Type checking enforced (@beartype decorators applied)
  • CrossHair exploration completed: hatch run contract-test-exploration
  • Contract violations reviewed and addressed

Test Execution

  • Contract validation: hatch run contract-test-contracts
  • Contract exploration: hatch run contract-test-exploration
  • Scenario tests: hatch run contract-test-scenarios
  • Full test suite: modules-side hatch run test -- -q / targeted review tests ✅

Test Quality

  • CLI commands tested with typer test client
  • Edge cases covered with Hypothesis property tests
  • Error handling tested with invalid inputs
  • Rich console output verified manually or with snapshots

How Has This Been Tested?

Contract-First Approach: TDD evidence was captured in openspec/changes/code-review-01-module-scaffold/TDD_EVIDENCE.md, targeted review tests passed before/after implementation, and the modules repo now auto-resolves the paired specfact-cli editable dependency for future worktrees.

Manual Testing

  • Tested CLI commands manually
  • Verified rich console output
  • Tested with different input scenarios
  • Checked error messages for clarity

Automated Testing

  • Contract validation passes
  • Property-based tests cover edge cases
  • Scenario tests cover user workflows
  • All existing tests still pass

Test Environment

  • Python version: 3.11
  • OS: Ubuntu Linux

Checklist

  • My code follows the style guidelines (PEP 8, ruff format, isort)
  • I have performed a self-review of my code
  • I have added/updated contracts (@icontract, @beartype)
  • I have added/updated docstrings (Google style)
  • I have made corresponding changes to documentation
  • My changes generate no new warnings (basedpyright, ruff, pylint)
  • All tests pass locally
  • I have added tests that prove my fix/feature works
  • Any dependent changes have been merged

Quality Gates Status

  • Type checking ✅ (hatch run type-check)
  • Linting ✅ (hatch run lint)
  • Contract validation ✅ (hatch run contract-test-contracts)
  • Contract exploration ✅ (hatch run contract-test-exploration)
  • Scenario tests ✅ (hatch run contract-test-scenarios)

Screenshots/Recordings (if applicable)

  • specfact code review --help shows run, ledger, and rules.

@djm81 djm81 self-assigned this Mar 11, 2026
@djm81 djm81 added enhancement New feature or request module-system Module system and registry QA Quality Assurance labels Mar 11, 2026
@djm81 djm81 moved this from Todo to In Progress in SpecFact CLI Mar 11, 2026
@djm81 djm81 merged commit e91e672 into dev Mar 11, 2026
13 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in SpecFact CLI Mar 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request module-system Module system and registry QA Quality Assurance

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

[Change] code-review-01 - specfact-code-review Module Scaffold with Pydantic Models

1 participant