morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

[PR #3086] [MERGED] docs(process): clarify terminal progress message fields #5604

New issue

Closed

opened 2026-10-31 01:07:54 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 01:07:54 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/3086
Author: @1052326311
Created: 10/14/2026
Status: ✅ Merged
Merged: 10/14/2026
Merged by: @N0zoM1z0

Base: main ← Head: docs/process-progress-message

📝 Commits (1)

9c85ec3 docs(process): clarify terminal progress message fields

📊 Changes

1 file changed (+24 additions, -8 deletions)

View changed files

📝 docs/process-capture.md (+24 -8)

📄 Description

Summary

Fixes #3052. Clarify that the final capture-process progress line carries disposition and cleanup states as key=value text inside message, with a complete JSON example.

Problem and expected behavior

The old text said the final line “adds disposition” alongside documented JSON fields. A consumer reading rea_progress.disposition would receive no value. The guide now identifies the actual location and names the cleanup keys.

Change and scope

Only docs/process-capture.md changes. The existing progress producer and CLI/MCP behavior establish this documentation correction; no new capability or maintainer scope decision is required.

Contract and boundary impact

Semantic owner: progress documentation, checked against ProcessCaptureProgress.formatProgressMessage and its consumers.
Contribution scope: correction of misleading operator instructions within existing behavior.
CLI/MCP schemas, Evidence, provider/platform support, cleanup authority, generated metadata and package/install behavior: unchanged.

Expected effects:

Documentation or usability only; no target interaction.

Evidence and regression coverage

Existing progress tests exercise the compiled CLI with real local child processes and MCP transport, including ordinary exit, timeout and cancellation.
The existing parser reads disposition and cleanup states from message; no new test duplicates that coverage.
The example illustrates the wire shape; elapsed time/counts/sequence vary by run.
Coverage: macOS arm64, Node 24.18.0; Windows and live analysis providers were not exercised.

Validation performed

npm run test:focused -- tests/boundary/process/processCaptureProgress.test.ts — 6 passed.
npm run check — passed, including build/static checks and architecture guards.
npm run docs:check — passed, including 5 README consistency tests.
git diff --check — passed.

Validated on base c7105d97; publication refresh found unrelated main changes through 70771523, with the progress producer and this documentation unchanged.

Compatibility, safety, and release

No breaking change, migration, release metadata, or execution/cleanup change. The local verification launched only test child processes through existing capture workflows.

Before merge

Concrete issue, focused scope and conventional title.
Existing contract and relevant tests checked; proof limits stated.
Owning documentation corrected; generated contract changes not required.
Diff inspected for secrets, generated output and unrelated edits.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/3086 **Author:** [@1052326311](https://github.com/1052326311) **Created:** 10/14/2026 **Status:** ✅ Merged **Merged:** 10/14/2026 **Merged by:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Base:** `main` ← **Head:** `docs/process-progress-message` --- ### 📝 Commits (1) - [`9c85ec3`](https://github.com/morluto/rea/commit/9c85ec335f5b31315680dcfd37b1979974c39768) docs(process): clarify terminal progress message fields ### 📊 Changes **1 file changed** (+24 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `docs/process-capture.md` (+24 -8) </details> ### 📄 Description ## Summary Fixes #3052. Clarify that the final `capture-process` progress line carries disposition and cleanup states as `key=value` text inside `message`, with a complete JSON example. ## Problem and expected behavior The old text said the final line “adds `disposition`” alongside documented JSON fields. A consumer reading `rea_progress.disposition` would receive no value. The guide now identifies the actual location and names the cleanup keys. ## Change and scope Only `docs/process-capture.md` changes. The existing progress producer and CLI/MCP behavior establish this documentation correction; no new capability or maintainer scope decision is required. ## Contract and boundary impact - Semantic owner: progress documentation, checked against `ProcessCaptureProgress.formatProgressMessage` and its consumers. - Contribution scope: correction of misleading operator instructions within existing behavior. - CLI/MCP schemas, Evidence, provider/platform support, cleanup authority, generated metadata and package/install behavior: unchanged. Expected effects: - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage - Existing progress tests exercise the compiled CLI with real local child processes and MCP transport, including ordinary exit, timeout and cancellation. - The existing parser reads disposition and cleanup states from `message`; no new test duplicates that coverage. - The example illustrates the wire shape; elapsed time/counts/sequence vary by run. - Coverage: macOS arm64, Node 24.18.0; Windows and live analysis providers were not exercised. ## Validation performed - `npm run test:focused -- tests/boundary/process/processCaptureProgress.test.ts` — 6 passed. - `npm run check` — passed, including build/static checks and architecture guards. - `npm run docs:check` — passed, including 5 README consistency tests. - `git diff --check` — passed. Validated on base `c7105d97`; publication refresh found unrelated main changes through `70771523`, with the progress producer and this documentation unchanged. ## Compatibility, safety, and release No breaking change, migration, release metadata, or execution/cleanup change. The local verification launched only test child processes through existing capture workflows. ## Before merge - [x] Concrete issue, focused scope and conventional title. - [x] Existing contract and relevant tests checked; proof limits stated. - [x] Owning documentation corrected; generated contract changes not required. - [x] Diff inspected for secrets, generated output and unrelated edits. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 01:07:54 +00:00

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

2026-11-01 21:44:42 +00:00

[PR #5647] [MERGED] fix(doctor): reject unusable Kuna caches and invalid native settings #7010

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

morluto/rea#5604

No description provided.

Rows
Columns