Re: [PATCH nft 1/3] tests: shell: README: copy edit

[Phil Sutter <phil@nwl.cc>]

Hi,

On Thu, Oct 21, 2021 at 10:30:25AM +0200, Štěpán Němec wrote:
> On Wed, 20 Oct 2021 17:04:02 +0200
> Phil Sutter wrote:
> 
> > What you you mean with 'copy edit'?
> 
> https://en.wikipedia.org/wiki/Copy_editing

Ah, thanks! I didn't know the term.

> > Please make subject line a bit more comprehensible.
> 
> Would "fix language issues" work for you? Or, could we perhaps keep the
> original subject, and add "fix language issues" in the body, to address
> your other concern?

Yes, I'm fine with keeping the subject if a description is added.

> > Also, adding at least a single line of description is mandatory, even
> > if the subject speaks for itself.
> 
> Commit messages consisting of only the subject and trailers (SOB et al.)
> are quite common, both in this project and elsewhere. [1]

Well yes, roughly 10% of all commits in nftables repo are. In iptables
repo it's even worse with close to 50%. Thanks a lot for providing the
script, BTW! :)

> I suppose that as someone responsible for reviewing and applying
> patches, you're free to install any hoops you see fit for contributors
> to jump through, but if it is the project's and contributors' best
> interest you have in mind, I think it would be better if you mentioned
> the "description is always mandatory" rule explicitly in patch
> submission guidelines [2] (providing a rationale and being consistent
> about it in reality would be better still).

Sorry for not checking the guideline but quoting advice I once received
from the top of my head instead. Maybe I was incorrect and in obvious
cases the description is optional. The relevant text in [2] at least
doesn't explicitly state it is, while being pretty verbose about it
regarding cover letters.

Cheers, Phil

> [2] https://wiki.nftables.org/wiki-nftables/index.php/Portal:DeveloperDocs/Patch_submission_guidelines