[openstack-dev] [hacking] rules for removal
sean at dague.net
Fri Jun 20 18:07:39 UTC 2014
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 -
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
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
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 482 bytes
Desc: OpenPGP digital signature
More information about the OpenStack-dev