summaryrefslogtreecommitdiff
path: root/HACKING.rst
diff options
context:
space:
mode:
authorJoshua Powers <josh.powers@canonical.com>2019-12-17 14:21:36 -0800
committerDaniel Watkins <oddbloke@ubuntu.com>2019-12-17 17:21:36 -0500
commit45cd8e19dacb0938df505646d805bfcd6b723a41 (patch)
treeb45f52139a6419e89ce1f1f34ea01ea83458ccc1 /HACKING.rst
parent77c5a6522b288cea9e88991cc5b3bad6174fde6f (diff)
downloadvyos-cloud-init-45cd8e19dacb0938df505646d805bfcd6b723a41.tar.gz
vyos-cloud-init-45cd8e19dacb0938df505646d805bfcd6b723a41.zip
doc: specify _ over - in cloud config modules
Start a design decision area in HACKING to capture highlevel decisions. First example is to capture the use of _ over - in cloud config modules. LP: #1293254
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`).