Merge pull request #257 from ffromani/add-rationale-md

docs: kickstart rationale doc
k8stopologyawareschedwg · Nov 29, 2023 · 51fd537 · 51fd537
2 parents b5639b3 + 2fe652b
commit 51fd537
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/RATIONALE.md b/RATIONALE.md
@@ -0,0 +1,11 @@
+# Notable rationale of deployer toolkit
+
+## command line flags convention
+
+The canonical representation of flags in this package is:
+* single-dash for one-char flags (-v, -h)
+* double-dash for multi-char flags (--foo, --long-option)
+pflag allows one-char to have one or two dashes.
+
+The tooling we configure all use `pflag`, so our canonical
+representation is more restrictive of those.
diff --git a/README.md b/README.md
@@ -18,6 +18,8 @@ the `deployer` project wants to help anyone which want to work with the topology
 - a set of reusable golang packages which can be used by other golang projects to deploy/undeploy or in general
   interact with the topology-aware stack components (e.g. operators)
 
+please check `RATIONALE.md` for more detailed development notes about rationale for technical decisions.
+
 ## requirements
 
 * kubernetes >= 1.21