Re: [PATCH 2/2] apply: rewrite unit tests with structured cases

From: Kristoffer Haugsbakk <code@khaugsbakk.name>
Date: Feb 19, 2024, 22:04 UTC
Message-ID: <423c4144-56dd-4897-9b81-badf67e22420@app.fastmail.com>
In-Reply-To: <7dab12ab7b8af3e6a0778fc1a01dd1479990bcff.1708317938.git.gitgitgadget@gmail.com>

On Mon, Feb 19, 2024, at 05:45, Philip Peterson via GitGitGadget wrote:

Show 7 quoted lines

> From: Philip Peterson <philip.c.peterson@gmail.com>
>
> The imperative format was a little hard to read, so I rewrote the test cases
> in a declarative style by defining a common structure for each test case and
> its assertions.
>
> Signed-off-by: Philip Peterson <philip.c.peterson@gmail.com>

IMO in general you can just assert that X and Y in the commit message.

  “ The imperative format is hard to read. Rewrite the test cases …

If your patch passes review and is merged then that’s the truth as determined by you and the reviewers.

More subjective-sounding “This was hard to read” and maybe anecdotes like “this tripped me up when reading” can go outside the commit message like the cover letter or the free-form space between the commit message and the patch (after the three-hyphen/three-dash lines).

-- 
Kristoffer Haugsbakk