Permalink
Browse files

Update contrib guide to discuss config option standards

  • Loading branch information...
1 parent 1e74c1b commit f4b76c0b89140b2e555fbd16634250133c55cc1c @irskep irskep committed Dec 15, 2012
Showing with 14 additions and 0 deletions.
  1. +7 −0 CONTRIBUTING.rst
  2. +7 −0 docs/guides/contributing.rst
View
@@ -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.
@@ -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
-----------------------------

0 comments on commit f4b76c0

Please sign in to comment.