Updated Style Guide

userfrosting · Jan 13, 2019 · f544343 · f544343
1 parent 472ac0f
commit f544343
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-# Change Log
+# Changelog
 
 All notable changes to this project will be documented in this file.
 

diff --git a/README.md b/README.md
@@ -46,3 +46,7 @@ print_r($session->all());
 $session->destroy();
 
 ```
+
+## [Style Guide](STYLE-GUIDE.md)
+
+<!-- ## [Testing](RUNNING_TESTS.md) -->
diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md
@@ -1,4 +1,4 @@
-# Style guide for contributing to userfrosting/i18n
+# Style guide for contributing
 
 ## PHP
 
@@ -13,11 +13,11 @@ In addition:
 
 ```
 /**
- * UserFrosting i18n (http://www.userfrosting.com)
+ * UserFrosting Session (http://www.userfrosting.com)
  *
- * @link      https://github.com/userfrosting/i18n
- * @copyright Copyright (c) 2013-2019 Alexander Weissman, Louis Charette
- * @license   https://github.com/userfrosting/i18n/blob/master/LICENSE.md (MIT License)
+ * @link      https://github.com/userfrosting/session
+ * @copyright Copyright (c) 2019 Alexander Weissman
+ * @license   https://github.com/userfrosting/session/blob/master/LICENSE.md (MIT License)
  */
  ```
 
@@ -39,13 +39,12 @@ In addition:
  - 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.
 
+## Automatically fixing coding style with PHP-CS-Fixer
 
- ## Automatically fixing coding style with PHP-CS-Fixer
+[PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) can be used to automatically fix PHP code styling. UserFrosting provides a project specific configuration file ([`.php_cs`](.php_cs)) with a set of rules reflecting our style guidelines. This tool should be used before submitting any code change to assure the style guidelines are met. Every sprinkles will also be parsed by the fixer.
 
- [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) can be used to automatically fix PHP code styling. UserFrosting provides a project specific configuration file ([`.php_cs`](.php_cs)) with a set of rules reflecting our style guidelines. This tool should be used before submitting any code change to assure the style guidelines are met. Every sprinkles will also be parsed by the fixer.
+PHP-CS-Fixer is automatically loaded by Composer and can be used from the UserFrosting root directory :
 
- PHP-CS-Fixer is automatically loaded by Composer and can be used from the UserFrosting root directory :
-
- ```
- vendor/bin/php-cs-fixer fix
- ```
+```
+vendor/bin/php-cs-fixer fix
+```