Re: [yocto-patches] [wic][PATCH v3 10/10] tests/docs: add the review rubric

Paul Barker <[email protected]> Mon, 06 Jul 2026 10:08:39 +0100

Newsgroups	org.yoctoproject.lists.yocto-patches
Message-ID	<[email protected]>

On Wed, 2026-07-01 at 03:40 -0400, Trevor Woerner via
lists.yoctoproject.org wrote:
> The suite already documents how to write a test (authoring.md) and how
> it is linted (linting.md), but not how a test change is judged. This
> adds tests/docs/reviewing.md, the review-time companion to authoring.md,
> so the standard a change is held to is written down where both
> reviewers and contributors can see it.
> 
> The rubric records the conventions the suite is built on:
> 
>   - one function per commit, with the subject keyed to the test file;
>   - a test asserts the correct behaviour, and when it exposes a defect
>     the source fix lands in the same commit rather than as an xfail or a
>     test that bakes in the wrong result;
>   - a fix must be proven to matter by backing it out and watching the
>     test go red;
>   - the suite is green and lint-clean at every commit, not only at the
>     tip of a series;
>   - assertions are specific, boundaries are probed, and an assertion is
>     never weakened to force a pass;
>   - coverage is read as a guide to untested branches, not a score;
>   - each commit message stands alone and references no other commit.
> 
> It closes with a short reviewer checklist that collects those points,
> and is linked from the docs table in the suite README.
> 
> AI-Generated: codex/claude-opus 4.8 (xhigh)
> Signed-off-by: Trevor Woerner <[email protected]>

The comments I've made earlier in the series apply here as well. Is this
for the AI agent? Does it need to explain such generic ideas as
one change per commit?

Best regards,

-- 
Paul Barker

signature.asc (application/pgp-signature, 252 B)