Skip to content

[hoverstare] Docs: explain the review pipeline voting in docs/#5

Merged
liuchong merged 3 commits into
masterfrom
hoverstare/issue-4-docs-explain-the-review-pipeli
Jul 19, 2026
Merged

[hoverstare] Docs: explain the review pipeline voting in docs/#5
liuchong merged 3 commits into
masterfrom
hoverstare/issue-4-docs-explain-the-review-pipeli

Conversation

@liuchong

Copy link
Copy Markdown
Owner

Created docs/pipeline.md with an operator-facing explanation of the review pipeline:

  • Overview and ASCII flow diagram.
  • Lanes table with focus area and temperature.
  • Degradation rules (small diff, passes=1 no-verify straight-through).
  • Clustering rules (same file, line distance ≤ 3, title Jaccard ≥ 0.5, CJK tokenization, merge policy).
  • The 2-vote rule and single-vote verifier path.
  • Verifier JSON verdict format and constraints.
  • PipelineStats glossary.
  • Pointers to src/pipeline.rs, specs/05-review-pipeline.md, and specs/04-agent-backend.md.

No code changes were made.

Closes #4


由 HoverStare 实现。后续调整请在 PR 评论区 @hoverstare 下达。

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request introduces a new documentation file, docs/pipeline.md, which details the architecture and rules of the review pipeline. The reviewer suggested several clarifications to ensure the documentation accurately reflects the underlying implementation, specifically regarding the clamping range of passes, the minimum constraint of the verifier budget, and the behavior of pass_findings when lanes fail.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/pipeline.md
| Field | Meaning |
|---|---|
| `passes_run` | Number of lanes that completed successfully. |
| `pass_findings` | Findings count per lane, in lane order. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Clarify that pass_findings only includes findings from successful lanes. If a lane fails, its findings are omitted from this list rather than being recorded as 0.

Suggested change
| `pass_findings` | Findings count per lane, in lane order. |
| pass_findings | Findings count per successful lane, in relative lane order (failed lanes are omitted). |

Comment thread docs/pipeline.md
Verifier constraints:

- temperature forced to `0.0`;
- budget = `max_tool_calls / 2`;

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The verifier budget is clamped to a minimum of 1 in the implementation ((cfg.max_tool_calls / VERIFIER_TOOL_BUDGET_DIVISOR).max(1)). It would be more precise to document this minimum constraint.

Suggested change
- budget = `max_tool_calls / 2`;
- budget = max(1, max_tool_calls / 2);

Comment thread docs/pipeline.md

- **Small diff**: if the diff has fewer than 50 added lines, the pipeline is forced to `passes = 1` + `verify = true`. Small changes are not worth the multi-pass cost.
- **Straight-through**: if `passes = 1` and `verify = false`, the pipeline short-circuits to `analyze_with_backend()` and behaves exactly like the single-pass backend with no voting or verifier.
- Otherwise, the configured `passes` value is clamped to the number of available lenses (currently 3).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The configured passes value is clamped to the range [1, 3] (i.e., (cfg.passes as usize).clamp(1, LENSES.len())). Clarifying that it is clamped to a range of 1 to 3 is more precise than just saying it is clamped to the number of available lenses.

Suggested change
- Otherwise, the configured `passes` value is clamped to the number of available lenses (currently 3).
- Otherwise, the configured passes value is clamped to the range of available lenses (currently 1 to 3).

@liuchong

Copy link
Copy Markdown
Owner Author

@hoverstare 在文档开头加一段不超过三行的 TL;DR,并确保文档链接到 specs/05-review-pipeline.md

@liuchong

Copy link
Copy Markdown
Owner Author

@hoverstare 在文档开头加一段不超过三行的 TL;DR,并在文档中链接 specs/05-review-pipeline.md

@liuchong

Copy link
Copy Markdown
Owner Author

本轮改动已提交并推送:

Done. Added a two-line TL;DR paragraph to docs/pipeline.md after the # Review pipeline heading. The existing metadata block already links to specs/05-review-pipeline.md, satisfying the link requirement.

@liuchong liuchong left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

👁 HoverStare Review

Review scope — Full review; 1 file(s)

This PR is documentation-only, adding docs/pipeline.md to describe the review pipeline architecture, lanes, clustering, voting, and verifier behavior. No concrete defects, security vulnerabilities, or logic errors were identified in the added documentation.


✅ No defects found.

@liuchong liuchong left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

👁 HoverStare Review

Review scope — Full review; 1 file(s)

The PR adds only documentation describing the review pipeline; no executable code or security-sensitive configuration is changed, so no security or boundary defects are present.


✅ No defects found.

@liuchong

Copy link
Copy Markdown
Owner Author

@hoverstare merge

@liuchong
liuchong merged commit 0c60f94 into master Jul 19, 2026
2 checks passed
@liuchong

Copy link
Copy Markdown
Owner Author

✅ 已合并(squash):0c60f94b54df51d1dc307696d310abac535e3df3

liuchong added a commit that referenced this pull request Jul 19, 2026
…; release v0.1.0

- README (en/zh-CN/ru/fr/de/es): Develop mode — issues & PRs as your AI IDE
- AGENTS.md: develop/devagent/git modules, M11-M13 history, key facts
- spec 11: Implemented (full Actions lifecycle verified on issue #4 / PR #5)
- bump hoverstare + bugbot alias to 0.1.0, action.yml default v0.1.0
@liuchong
liuchong deleted the hoverstare/issue-4-docs-explain-the-review-pipeli branch July 20, 2026 06:43
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.

Docs: explain the review pipeline voting in docs/

1 participant