[openstack-dev] Reviewing spelling and grammar errors in blueprints Re: [Nova] nova-specs
Carl Baldwin
carl at ecbaldwin.net
Thu Apr 17 18:04:39 UTC 2014
Personally, I try not to be disagreeable and to be considerate in my
reviews. However, I don't want to worry too much about hurting
someone's feelings by making a comment. As a community we should be
considerate and polite but we should also embrace critical reviews of
our own work.
I think adding a note for a minor mistake is fine. I appreciate those
in reviews of my own patches. I mark them "nit: ..." and I don't give
-1 for nits. To me, the definition of a nit is something that I
noticed, thought I'd point it out but I would not try to hold up the
patch for it. Keep in mind though, that nit comments might be mixed
in with other comments that are worthy of -1. If the author wishes to
roll the patch for some other reason then the nits should be
considered.
My $0.02
Carl
On Thu, Apr 17, 2014 at 7:41 AM, Stefano Maffulli <stefano at openstack.org> wrote:
> On 04/16/2014 07:56 PM, Dan Smith wrote:
>>> Do we really want to -1 for spelling mistake in nova-specs?
>>
>> I do, yes. These documents are intended to be read by deployers and
>> future developers. I think it's really important that they're useful in
>> that regard.
>
> Guys, use your judgement with this. If a spelling mistake is really an
> impediment to understanding the meaning of the sentence or introduces
> ambiguity, by all mean fix it (i.e. provide a correction, for native
> English speakers).
>
> Always imagine that on the other side there is someone who has feelings
> and may have already done an immense effort to learn how to express
> technical concepts in a foreign language. Getting a vote for a small
> thing brings any adult back to childhood memories and may cause bad
> feelings.
>
> Be very very careful. I know most of reviewers are already being
> careful, I'm just piling up on top of that carefuless: there is never
> enough :)
>
> Please don't -1 if it's a minor grammar/spelling mistake that doesn't
> prevent proper understanding of the blueprint by a person skilled in the
> art.
>
> /stef
>
> --
> Ask and answer questions on https://ask.openstack.org
>
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
More information about the OpenStack-dev
mailing list