[openstack-dev] [hacking] rules for removal
Amrith Kumar
amrith at tesora.com
Sun Jun 22 13:41:50 UTC 2014
In addition to making changes to the hacking rules, why don't we mandate also
that perceived problems in the commit message shall not be an acceptable
reason to -1 a change.
Would this improve the situation?
-amrith
--
Amrith Kumar, CTO Tesora (www.tesora.com)
Twitter: @amrithkumar
IRC: amrith @freenode
| -----Original Message-----
| From: Sean Dague [mailto:sean at dague.net]
| Sent: Friday, June 20, 2014 2:08 PM
| To: OpenStack Development Mailing List (not for usage questions)
| Subject: [openstack-dev] [hacking] rules for removal
|
| After seeing a bunch of code changes to enforce new hacking rules, I'd
| like to propose dropping some of the rules we have. The overall patch
| series is here -
| https://review.openstack.org/#/q/status:open+project:openstack-
| dev/hacking+branch:master+topic:be_less_silly,n,z
|
| H402 - 1 line doc strings should end in punctuation. The real statement is
| this should be a summary sentence. A sentence is not just a set of words
| that end in a period. Squirel fast bob. It's something deeper.
| This rule thus isn't really semantically useful, especially when you are
| talking about at 69 character maximum (79 - 4 space indent - 6 quote
| characters).
|
| H803 - First line of a commit message must *not* end in a period. This was
| mostly a response to an unreasonable core reviewer that was -1ing people
| for not having periods. I think any core reviewer that -1s for this either
| way should be thrown off the island, or at least made fun of, a lot.
| Again, the clarity of a commit message is not made or lost by the lack or
| existence of a period at the end of the first line.
|
| H305 - Enforcement of libraries fitting correctly into stdlib, 3rdparty,
| our tree. This biggest issue here is it's built in a world where there was
| only 1 viable python version, 2.7. Python's stdlib is actually pretty
| dynamic and grows over time. As we embrace more python 3, and as distros
| start to make python3 be front and center, what does this even mean? The
| current enforcement can't pass on both python2 and python3 at the same
| time in many cases because of that.
|
| We have to remember we're all humans, and it's ok to have grey space.
| Like in 305, you *should* group the libraries if you can, but stuff like
| that should be labeled as 'nit' in the review, and only ask the author to
| respin it if there are other more serious issues to be handled.
|
| Let's optimize a little more for fun, and stop throwing -1s for silly
| things. :)
|
| -Sean
|
| --
| Sean Dague
| http://dague.net
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 6559 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20140622/4752a6f5/attachment.bin>
More information about the OpenStack-dev
mailing list