summaryrefslogtreecommitdiff
path: root/docs/coding-standards.markdown
diff options
context:
space:
mode:
authorFrédéric Guillot <fred@kanboard.net>2014-08-18 17:55:09 -0700
committerFrédéric Guillot <fred@kanboard.net>2014-08-18 17:55:09 -0700
commit5da8cf8a8f1f30f084fcd85d78bd8ff43675f1e7 (patch)
tree722b967af5b12f51feb5d965ccf3e849d7a7bb2f /docs/coding-standards.markdown
parent995a1a262a2f86bbaaa5d8b78569a2111bde4124 (diff)
Add some doc for contributors
Diffstat (limited to 'docs/coding-standards.markdown')
-rw-r--r--docs/coding-standards.markdown23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/coding-standards.markdown b/docs/coding-standards.markdown
new file mode 100644
index 00000000..a6975190
--- /dev/null
+++ b/docs/coding-standards.markdown
@@ -0,0 +1,23 @@
+Coding standards
+================
+
+PHP code
+--------
+
+- Indentation: 4 spaces
+- Line return: Unix => `\n`
+- Encoding: UTF-8
+- 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`