Why are those sorts of instructions replicated in each project in the first place? Shouldn't they be in the wiki?<br><br><div class="gmail_quote">On Thu, Mar 22, 2012 at 12:22 PM, Andrew Bogott <span dir="ltr"><<a href="mailto:abogott@wikimedia.org">abogott@wikimedia.org</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"> Just now I set out to merge a recent style guide change from python-novaclient into the hacking docs of other OpenStack projects. My patch didn't apply, though, because each project has subtly diverging HACKING files.<br>
<br>
Rather than contribute to this divergence, I've now read and compared the style guides from Nova, Glance, Keystone, python-keystoneclient, and python-novaclient. From these diffs I've created a file (attached) that encompasses the total of all guidelines from all projects. Remarkably, this merge produced only minor disagreements, described below under the heading FLAMEBAIT.<br>
<br>
I propose that this unified style guide be copied into each of the above projects, with a mandate to maintain consistency henceforth. Any objections?<br>
<br>
-Andrew<br>
<br>
<br>
FLAMEBAIT (docstring format):<br>
<br>
The only explicit contradiction I came across is regarding docstring formatting. Glance says this:<br>
<br>
**DO NOT** leave an extra newline before the closing triple-double-quote.<br>
<br>
Nova, this:<br>
<br>
A docstring ends with an empty line before the closing quotations.<br>
<br>
I propose that we just pick one or the other, or remove both prescriptions.<br>
<br>
FLAMEBAIT (filename):<br>
<br>
Some projects have a HACKING file, and some have a HACKING.rst file. Doesn't .rst generally indicate a REST API definition? I propose that the file be called HACKING.<br>
<br>
<br>_______________________________________________<br>
Mailing list: <a href="https://launchpad.net/~openstack" target="_blank">https://launchpad.net/~openstack</a><br>
Post to : <a href="mailto:openstack@lists.launchpad.net">openstack@lists.launchpad.net</a><br>
Unsubscribe : <a href="https://launchpad.net/~openstack" target="_blank">https://launchpad.net/~openstack</a><br>
More help : <a href="https://help.launchpad.net/ListHelp" target="_blank">https://help.launchpad.net/ListHelp</a><br>
<br></blockquote></div><br>