docs(code): Clarify interface naming convention

Fixes #8293
Elgg · Jun 19, 2015 · de03d37 · de03d37
1 parent 642873b
commit de03d37
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/contribute/code.rst b/docs/contribute/code.rst
@@ -282,6 +282,18 @@ Use self-documenting variable names.  ``$group_guids`` is better than ``$array``
 
 Avoid double-negatives. Prefer ``$enable = true`` to ``$disable = false``.
 
+Interface names
+^^^^^^^^^^^^^^^
+
+Use the pattern `Elgg\{Namespace}\{Name}`.
+
+Do not include an `I` prefix or an `Interface` suffix.
+
+We do not include any prefix or suffix so that we're encouraged to:
+
+ * name implementation classes more descriptively (the "default" name is taken).
+ * type-hint on interfaces, because that is the shortest, easiest thing to do.
+
 Functions
 ^^^^^^^^^