Skip to content

docs(lfg): FAQ entry contradicts PR-body residual checklist from #1580 #1581

Description

@chouti

Problem

docs/guides/lfg.md has two contradictory statements about where leftover review findings go, after #1580 (0e758b60).

Step 6 of the pipeline (line 76) describes the new design:

Leftover actionable findings, plus any flagged settlement conflicts, become a ## Unapplied review findings checklist in the PR body for the reviewer to decide on: fix in-branch, dismiss, or file a ticket. lfg files tickets itself only when no PR will exist.

But the FAQ entry (line ~214) still describes the pre-#1580 behavior:

Where do leftover review findings go?
Not into the PR description. They are filed in the project tracker when possible, and carried in one run-report comment on the PR.

"Not into the PR description" directly contradicts step 6's "become a ## Unapplied review findings checklist in the PR body".

Suggested fix

Update the FAQ entry to match the post-#1580 design, e.g.:

They are listed as an ## Unapplied review findings checklist in the PR body for the reviewer to decide on; with no PR, lfg files them in the project tracker itself.

Found while reviewing the #1580 sync into a downstream fork.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions