From 797aca9341a4e8a34ea67308e0f02190f6fdf04c Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Thu, 12 Sep 2019 17:57:16 -0400
Subject: [PATCH] Add docs/style.md

---
 ext/afform/docs/style.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 ext/afform/docs/style.md

diff --git a/ext/afform/docs/style.md b/ext/afform/docs/style.md
new file mode 100644
index 0000000000..30063d2f67
--- /dev/null
+++ b/ext/afform/docs/style.md
@@ -0,0 +1,26 @@
+# Code Style
+
+## Naming
+
+The following naming conventions apply to directives defined within `afform.git`:
+
+* Standalone directives (e.g. `afModelProp` or `afField`), including forms (e.g. `afHtmlEditor`)
+    * The directive name must begin with the `af` prefix.
+    * Supplemental attributes SHOULD NOT begin with the `af` prefix.
+    * Example: `<af-model-prop type="Activity" name="myPhoneCall">`
+
+* Mix-in directives (e.g. `afMonaco` or `afApi4Action`)
+    * The directive name must begin with the `af` prefix.
+    * Supplemental attributes SHOULD begin with a prefix that matches the directive.
+    * Example: `<button af-api4-action="['Job', 'process_mailings', {}]` af-api4-success-msg="ts('Processed pending mailings')">
+
+__Discussion__: These differ in two ways:
+
+* Namespacing
+    * Standalone directives form an implicit namespace.
+      (*Anything passed to `<af-model-prop>` is implicitly about `af-model-prop`.)
+    * Mix-in directives must share a namespace with other potential mix-ins.
+      (*The *)
+* Directive arguments
+    * Standalone directives only take input on the supplemental attributes (`type="..."`).
+    * Mix-ins take inputs via the directive's attribute (`af-api4-action="..."`) and the supplemental attributes (`af-api4-success-msg="..."`).
-- 
2.25.1