[openstack-dev] [qa] Policy on spelling and grammar

Jay S Bryant jsbryant at us.ibm.com
Mon Nov 11 18:49:24 UTC 2013


+2 to Clint's comments.

As OpenStack gains a wider following in the corporate world and given that 
the code for OpenStack may be seen by anyone, I think it is very important 
to get spelling and grammar right.  I also think it is important to ensure 
that the commit messages concisely communicate the change that is being 
made.

I regularly comment on misspellings and in the case that a commit message 
is difficult to understand provide suggestions for rewording to make sure 
I understand what is being communicated.

So, I think -1's are fine as long is assistance is being provided.

The point of OpenStack is to have a collaborative community.  Some people 
bring better spelling and grammar to the table than others as a 
contribution.



Jay S. Bryant
Linux Developer - 
    OpenStack Enterprise Edition
                   
Department 7YLA, Building 015-2, Office E125, Rochester, MN
Telephone: (507) 253-4270, FAX (507) 253-6410
TIE Line: 553-4270
E-Mail:  jsbryant at us.ibm.com
--------------------------------------------------------------------
 All the world's a stage and most of us are desperately unrehearsed.
                   -- Sean O'Casey
--------------------------------------------------------------------



From:   Clint Byrum <clint at fewbar.com>
To:     openstack-dev <openstack-dev at lists.openstack.org>, 
Date:   11/11/2013 12:21 PM
Subject:        Re: [openstack-dev] [qa] Policy on spelling and grammar



Excerpts from David Kranz's message of 2013-11-11 09:58:59 -0800:
> I have seen a wide variety of -1'ing (and in many cases approving) 
> patches for minor spelling or grammatical errors and think we need a 
> policy about this. Given the large number of contributors for whom 
> English is not their native language, I would be in favor of rejecting 
> spelling errors in variable or method names but being more lenient in 
> comments, commit messages, READMEs, etc. What do you all think?
> 

The point of code review is to find defects. Misspelled words are defects
in the English language encoded in the change. In fact, commit messages
in particular are critical to get right as they cannot ever be fixed,
and they are generally the most useful when under a stressful situation
trying to determine the nature of a regression.

Many of our contributors are also newbies to python, and we do not let
them get away with obvious mistakes in python code. English is just a
language with a different interpreter (a more forgiving one, for sure,
but also one with many versions at various stages of implementation).

In fact, our large percentage of non-native english speakers is a reason
to be extremely careful about grammar and spelling so as not to confuse
non-native speakers with incorrect grammar and spelling.

I believe that if a -1 for a spelling mistake is causing more than an
extremely short turn around time then either the submitter is not engaged
with the project and thus not responsive to the -1, or the reviewers
are over-taxed and the given project needs more reviewers.

_______________________________________________
OpenStack-dev mailing list
OpenStack-dev at lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20131111/65f64f1e/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: image/jpeg
Size: 4229 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20131111/65f64f1e/attachment.jpe>


More information about the OpenStack-dev mailing list