Permalink
Browse files

docs(code): Clarify interface naming convention

Fixes #8293
  • Loading branch information...
ewinslow committed Jun 19, 2015
1 parent 642873b commit de03d372554b250f08ad510542dd6ac88138f055
Showing with 12 additions and 0 deletions.
  1. +12 −0 docs/contribute/code.rst
View
@@ -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
^^^^^^^^^

0 comments on commit de03d37

Please sign in to comment.