summaryrefslogtreecommitdiff
path: root/HACKING.rst
diff options
context:
space:
mode:
Diffstat (limited to 'HACKING.rst')
-rw-r--r--HACKING.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/HACKING.rst b/HACKING.rst
index 8c8e518f..c74bd5af 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -125,3 +125,15 @@ have any questions.
.. _tox: https://tox.readthedocs.io/en/latest/
.. _Ubuntu Server: https://github.com/orgs/canonical/teams/ubuntu-server
+
+Design
+======
+
+This section captures design decisions that are helpful to know when
+hacking on cloud-init.
+
+Cloud Config Modules
+--------------------
+
+* Any new modules should use underscores in any new config options and not
+ hyphens (e.g. `new_option` and *not* `new-option`).