diff options
author | Frederic Guillot <fred@kanboard.net> | 2015-08-29 20:00:53 -0400 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2015-08-29 20:00:53 -0400 |
commit | 6c711f696f73bc59813f6834ec241aef3b626cbd (patch) | |
tree | ded4f0e8c7f8c672414ff3f2f84eac0f6d9073e5 /doc/coding-standards.markdown | |
parent | ef087f5e22df1a0d97babef26aaf9b8960ee6d5d (diff) |
Include documentation in the application
Diffstat (limited to 'doc/coding-standards.markdown')
-rw-r--r-- | doc/coding-standards.markdown | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/coding-standards.markdown b/doc/coding-standards.markdown new file mode 100644 index 00000000..e0e762db --- /dev/null +++ b/doc/coding-standards.markdown @@ -0,0 +1,24 @@ +Coding standards +================ + +PHP code +-------- + +- Indentation: 4 spaces +- Line return: Unix => `\n` +- Encoding: UTF-8 +- Use only the opening tags `<?php` or `<?=` for templates, but **never** use `<?` +- Always write PHPdoc comments for methods and class properties +- Coding style: Try to follow [PSR-1](http://www.php-fig.org/psr/psr-1/) and [PSR-2](http://www.php-fig.org/psr/psr-2/) otherwise follow the actual style. + +Javascript code +--------------- + +- Indentation: 4 spaces +- Line return: Unix => `\n` + +CSS code +-------- + +- Indentation: 4 spaces +- Line return: Unix => `\n` |