Merge pull request Yelp#584 from irskep/update-contributing

Update contrib guide to discuss config option standards
tarnfeld · Jan 3, 2013 · 2e9d183 · 2e9d183
2 parents 1e74c1b + f4b76c0
commit 2e9d183
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -27,5 +27,12 @@ Things that will make your branch more likely to be pulled:
 * Reference relevant issue numbers in the tracker
 * API backward compatibility
 
+If you add a new configuration option, please try to do all of these things:
+
+* Make its name unambiguous in the context of multiple runners (e.g.
+  ``ec2_task_instance_type`` instead of ``instance_type``)
+* Add command line switches that allow full control over the option
+* Document the option and its switches in the appropriate file under ``docs``
+
 .. Copied from docs/guides/contributing.rst, which is the canonical text. This
    version exists only for Github.
diff --git a/docs/guides/contributing.rst b/docs/guides/contributing.rst
@@ -27,6 +27,13 @@ Things that will make your branch more likely to be pulled:
 * Reference relevant issue numbers in the tracker
 * API backward compatibility
 
+If you add a new configuration option, please try to do all of these things:
+
+* Make its name unambiguous in the context of multiple runners (e.g.
+  ``ec2_task_instance_type`` instead of ``instance_type``)
+* Add command line switches that allow full control over the option
+* Document the option and its switches in the appropriate file under ``docs``
+
 A quick tour through the code
 -----------------------------