From cf14306c2b3f82a81f8d56669a71633b4d4b5fce Mon Sep 17 00:00:00 2001
From: marvin-borner@live.com
Date: Mon, 16 Apr 2018 21:09:05 +0200
Subject: Main merge to user management system - files are now at /main/public/

---
 main/STYLE-GUIDE.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100755 main/STYLE-GUIDE.md

(limited to 'main/STYLE-GUIDE.md')

diff --git a/main/STYLE-GUIDE.md b/main/STYLE-GUIDE.md
new file mode 100755
index 0000000..94c10b2
--- /dev/null
+++ b/main/STYLE-GUIDE.md
@@ -0,0 +1,44 @@
+# Style guide for contributing to UserFrosting
+
+## PHP
+
+All PHP contributions must adhere to [PSR-1](http://www.php-fig.org/psr/psr-1/) and [PSR-2](http://www.php-fig.org/psr/psr-2/) specifications.
+
+In addition:
+
+### Documentation
+
+- All documentation blocks must adhere to the [PHPDoc](https://phpdoc.org/) format and syntax.
+- All PHP files MUST contain the following documentation block immediately after the opening `<?php` tag:
+
+```
+/**
+ * UserFrosting (http://www.userfrosting.com)
+ *
+ * @link      https://github.com/userfrosting/UserFrosting
+ * @license   https://github.com/userfrosting/UserFrosting/blob/master/licenses/UserFrosting.md (MIT License)
+ */
+ ```
+ 
+### Classes
+
+- All classes MUST be prefaced with a documentation block containing a description and the author(s) of that class.  You SHOULD add other descriptive properties as well.
+- All class members and methods MUST be prefaced with a documentation block.  Any parameters and return values MUST be documented.
+- The contents of a class should be organized in the following order: constants, member variables, constructor, other magic methods, public methods, protected methods, private methods, and finally, deprecated methods (of any type or visibility).
+- Setter methods SHOULD return the parent object.
+
+### Routes
+
+- Front controller (Slim) routes should be alphabetized, first by route type and then by route URL.  If you have route groups, those should come first and be alphabetized as well.
+
+### Variables
+ 
+ - All class member variables and local variables MUST be declared in `camelCase`.
+
+### Arrays
+
+ - Array keys MUST be defined using `snake_case`.  This is so they can be referenced in Twig and other templating languages.
+ - Array keys MUST NOT contain `.`.  This is because `.` is a reserved operator in Laravel and Twig's [dot syntax](https://medium.com/@assertchris/dot-notation-3fd3e42edc61).
+ - Multidimensional arrays SHOULD be referenced using dot syntax whenever possible.  So, instead of doing `$myArray['person1']['email']`, you should use `$myArray['person1.email']` if your array structure supports it.
+ 
+### Twig Templates
-- 
cgit v1.2.3