[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 1/2] docs: Fix botched rST conversion of 'submitting-a-patch.

From: Thomas Huth
Subject: Re: [PATCH 1/2] docs: Fix botched rST conversion of 'submitting-a-patch.rst'
Date: Mon, 22 Nov 2021 15:01:58 +0100
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.3.0

On 22/11/2021 14.53, Peter Maydell wrote:
On Mon, 22 Nov 2021 at 13:30, Thomas Huth <thuth@redhat.com> wrote:

On 22/11/2021 14.25, Peter Maydell wrote:
On Mon, 22 Nov 2021 at 12:37, Thomas Huth <thuth@redhat.com> wrote:
What about simply replacing it with a new sentence below the bullet list,

"Please also use a spell checker like `codespell
https://github.com/codespell-project/codespell` with your patches"

How many regular contributors actually do that?

Considering the typos that we have in the code, not enough ;-)

Anyway, it's just a polite recommendation here, not a must-do, so mentioning
codespell here doesn't really hurt, does it?

I don't think we should be recommending to new contributors that
they do things that established contributors generally do not do.
The document has enough "things you should do or think about" already.
My preference would be for simply not mentioning spelling-checking.

(If we do want to come up with some process for dealing with
spelling issues in the codebase, then we either need to put it
into CI so it's run automatically, or we need to have something
that works on the individual patch level.)

Ok ... In any case - seems like this needs more discussion, so I'll drop it from the patch for now. We can still add some wording or CI magic later, but that's certainly something that we rather want to do after version 6.2 has been released...


reply via email to

[Prev in Thread] Current Thread [Next in Thread]