Skip to content

Remove Scout-specific references - #10

Merged
cirsteve merged 2 commits into
mainfrom
agent/remove-scout-references
Sep 2, 2026
Merged

cirsteve merged 2 commits into
mainfrom
agent/remove-scout-references

Conversation

@cirsteve

@cirsteve cirsteve commented Sep 2, 2026 •

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation

    • Updated terminology to use generic consumer and contract language.
    • Clarified legacy archive replay, conformance coverage, production implementation history, and database autonomy expectations.
    • Renamed the legacy example archive and refreshed related package and quickstart references.
  • Tests

    • Updated conformance and contract checks to use the renamed legacy archive.
    • Refreshed test guidance and configuration terminology.
    • Updated build verification to include the renamed archive.

@cirsteve
cirsteve requested a lite review from Copilot September 2, 2026 21:17
@coderabbitai

coderabbitai Bot commented Sep 2, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Essentials

Run ID: 1c031cca-b59f-4b6e-b070-7ab491a67023

📥 Commits

Reviewing files that changed from the base of the PR and between e3153dd and daa957f.

📒 Files selected for processing (1)
  • tests/test_service.py
🚧 Files skipped from review as they are similar to previous changes (1)
  • tests/test_service.py

Included review availability: 3 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.


📝 Walkthrough

Walkthrough

The changes remove Scout-specific terminology from documentation, fixtures, package metadata, and tests. The legacy archive uses generic naming and paths. Test documentation now refers to the source consumer and package context.

Changes

Legacy archive generalization

Layer / File(s) Summary
Legacy archive replay and packaging
examples/legacy-archive/..., conformance/test_legacy_archive.py, packages/paa-contracts/...
The replay test, fixture actors, package artifact paths, verification script, and required-root checks now use legacy-archive.
Generic consumer documentation
PAA.md, README.md, examples/refund_quickstart/README.md, packages/paa-contracts/README.md, packages/paa-contracts/src/paa_contracts/__init__.py
Documentation now uses generic source-consumer terminology and describes consumer-owned database implementations.
Source suite test references
tests/test_declarations.py, tests/test_service.py
Test comments and docstrings now reference the source suite and package context. No runtime behavior changes occur in the service tests.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to daa95

This PR removes Scout-specific references across documentation, tests, and example/archive names. No actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 37.50% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 8 functions across 7 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: replacing Scout-specific references with generic terminology across documentation, tests, fixtures, and packaging paths.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/remove-scout-references

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

All consumer-specific references and paths appear consistently updated with only minor docstring wording nits remaining (fixes suggested in comments).

Pull request overview

This PR removes consumer-specific (“Scout”) references across tests, docs, and the paa-contracts artifact set, making the repository wording and fixture paths implementation-neutral while keeping the conformance corpus intact.

Changes:

  • Replaces “Scout” references in tests/docs with “source consumer” / neutral phrasing and updates the test actor env var to PAA_TEST_ACTOR.
  • Renames the archived capture artifact root from examples/scout-archive to examples/legacy-archive across paa-contracts and conformance tests.
  • Updates the pre-cutover capture JSON’s actor fields to remove Scout-specific naming.
File summaries
File Description
tests/test_service.py Updates porting references and test env var name; minor docstring text adjustments.
tests/test_declarations.py Updates module documentation to remove Scout-specific references.
README.md Updates project README wording about the pre-cutover capture’s origin.
packages/paa-contracts/tests/test_contracts.py Updates expected required artifact roots to examples/legacy-archive.
packages/paa-contracts/src/paa_contracts/init.py Updates required artifact roots to reference examples/legacy-archive.
packages/paa-contracts/scripts/verify_built_wheel.py Keeps wheel verification in sync with the renamed artifact directory.
packages/paa-contracts/README.md Makes consumer references implementation-neutral in the dependency diagram.
packages/paa-contracts/hatch_build.py Updates build hook artifact list to include examples/legacy-archive.
PAA.md Updates spec-mapping narrative to remove Scout-specific references and point to legacy-archive.
examples/refund_quickstart/README.md Removes Scout-specific wording in example documentation.
examples/legacy-archive/pre-cutover-capture.json Removes Scout-specific actor naming in the archived capture data.
conformance/test_legacy_archive.py Updates conformance test name/path to use legacy-archive and neutral phrasing.
Review details

Suppressed comments (1)

tests/test_service.py:9

  • The module docstring breaks the tests/test_declarations.py filename across a line break (tests/test_declarations. then py's), which reads like a sentence break rather than a path and is easy to misread.
Ported from the source consumer's service tests. Its in_memory_state
fixture, its module-global PRODUCER_REGISTRY, and its checked-in
contracts/paa declarations directory don't exist here — this package
ships no conftest, so a real SqliteEventStore against a tmp_path database
plus small local declaration fixtures (mirroring tests/test_declarations.
  • Files reviewed: 12/12 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread tests/test_service.py
Comment on lines 129 to 132
"""A RuntimeConfig pointed at a one-task declarations directory cloned
from _OUTBOUND_TASK with version/initial_position overridden — mirrors
Scout's _write_versioned_declaration technique for isolating a
The source suite's versioned-declaration technique for isolating a
declaration-version bump in a test."""
@cirsteve

cirsteve commented Sep 2, 2026

Copy link
Copy Markdown
Member Author

Addressed the latest review round in daa957f:

  • Reflowed the module docstring so tests/test_declarations.py remains intact.
  • Corrected the capitalization in the versioned-declaration docstring.

Validation: uv run pytest tests/test_service.py (59 passed) and uv run ruff check tests/test_service.py (passed).

@cirsteve
cirsteve merged commit 469b32b into main Sep 2, 2026
9 checks passed
@cirsteve
cirsteve deleted the agent/remove-scout-references branch September 2, 2026 21:54
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.

2 participants