[openstack-dev] [qa] Policy on spelling and grammar
cbkyeoh at gmail.com
Mon Nov 11 23:10:56 UTC 2013
On Tue, Nov 12, 2013 at 7:12 AM, Anne Gentle <anne at openstack.org> wrote:
> On Mon, Nov 11, 2013 at 1:28 PM, Tim Bell <Tim.Bell at cern.ch> wrote:
>> As a speaker of the Queen's English, I find flavor to be incorrect. Does
>> that mean I can -1 any patch that does not use flavour ?
>> At CERN, we are working with 130 countries in a single community. The
>> value of the contribution of non-english speakers far exceeds the
>> occasional misunderstandings.
>> Giving grammar/spellings -1 excludes major sections of the community from
>> As our aim is meritocracy (in python, computer architecture and design
>> rather than spelling), I'd propose
>> - If someone identifies a need for clarification/correction as part of a
>> review, they also submit the replacement text rather than just -1.
>> - The submitter incorporates that change into a patch
> Agreed on suggesting and even patching the patch to submit the replacement
> text. Spelling and grammar count.
> Related to the v3 Nova API - I would also like to see a wiki page that
> outlines our preferred wording and spelling so that reviewers have a "final
> say" wiki page to refer to. For example, I heard we want to move towards
> "servers" rather than "instances" for the API, but I'd need that written
> down somewhere to be sure I'm recalling it correctly. Does anyone have
> interest on these lists? If not I'll ask a docs person to start one.
There is no list and I do agree we need one. At summit I promised to write
up a V3 API review checklist on the wiki and can put it in there, but am
fine if you think there is somewhere else better that it belongs
Can we also just decide on tenant vs project across Openstack? It's pretty
confusing for new people to see both terms used within even the same
> At docs boot camp, we talked about English-second-language coders and
> reviewers and I'm requesting here that the native speakers step up to write
> things down. I hadn't realized how many non-native speakers we have, it's
> awesome, so let's accommodate while still valuing good communication.
>> > -----Original Message-----
>> > From: John Griffith [mailto:john.griffith at solidfire.com]
>> > Sent: 11 November 2013 20:03
>> > To: OpenStack Development Mailing List (not for usage questions)
>> > Subject: Re: [openstack-dev] [qa] Policy on spelling and grammar
>> > On Tue, Nov 12, 2013 at 2:49 AM, James Slagle <james.slagle at gmail.com>
>> > > -1 from me as well.
>> > >
>> > > When I first started with OpenStack, I probably would have agreed with
>> > > letting small grammar mistakes and typos slide by.
>> > >
>> > > However, I now feel that getting commit messages right is more
>> > > important. Also keep in mind that with small grammar mistakes, the
>> > > intent may be obvious to a native English speaker, but to another
>> > > non-native English speaker it may not be. And just a few small
>> > > grammar mistakes/misspellings/typos can add up until the meaning may
>> > > be harder to figure out for another non-native English speaker.
>> > >
>> > > Also, I can't speak for everyone, but in general I've found most folks
>> > > open to grammar corrections if English is not their native language
>> > > b/c they want to learn and fix the mistakes.
>> > >
>> > >
>> > > --
>> > > -- James Slagle
>> > > --
>> > >
>> > > _______________________________________________
>> > > OpenStack-dev mailing list
>> > > OpenStack-dev at lists.openstack.org
>> > > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>> > Guess I'm in the minority with here... some of the nits in commit
>> messages and comments is a bit extreme. Sure there are some cases
>> > where I think offering a correction is great/appropriate, but for
>> example issuing a -1 on somebody's patch because they mixed up their
>> > use of 'there' seems a bit lame.
>> > Seems to me there's a middle ground here, but honestly if you're value
>> add to the review process is catching grammatical or spelling
>> > errors in comments and commit messages I'd argue that in most cases it
>> would be nice to have more substantive feedback to go along
>> > with it. I happen to be a top offender here in terms of grammar or
>> spelling errors in comments so I'm a bit biased on the topic. :)
>> > _______________________________________________
>> > OpenStack-dev mailing list
>> > OpenStack-dev at lists.openstack.org
>> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>> OpenStack-dev mailing list
>> OpenStack-dev at lists.openstack.org
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the OpenStack-dev