Merge branch 'develop' into rewrites/coding-convention-split2

[friendica.git] / doc / Developers-Intro.md

diff --git a/doc/Developers-Intro.md b/doc/Developers-Intro.md
index 53981d0c298c8f7dd4760863822f1f373539bd2c..61b300b0cc2f5c876f53e6dd51d7b7b613bcfabd 100644 (file)
--- a/doc/Developers-Intro.md
+++ b/doc/Developers-Intro.md
@@ -49,9 +49,9 @@ Programming
 
 ###Coding standards
 
-For the sake of consistency between contribution and general code readability, Friendica follows the widespread [PSR-2 coding standards](http://www.php-fig.org/psr/psr-2/).
-Here's a few primers if you are new to the PSR-2 coding standards:
- * Indentation is 4 spaces, period.
+For the sake of consistency between contribution and general code readability, Friendica follows the widespread [PSR-2 coding standards](http://www.php-fig.org/psr/psr-2/) to the exception of a few rules.
+Here's a few primers if you are new to Friendica or to the PSR-2 coding standards:
+ * Indentation is tabs, period (not PSR-2).
  * By default, strings are enclosed in single quotes, but feel free to use double quotes if it makes more sense (SQL queries, adding tabs and line feeds).
  * Operators are wrapped by spaces, e.g. `$var === true`, `$var = 1 + 2` and `'string' . $concat . 'enation'`
  * Braces are mandatory in conditions
@@ -61,6 +61,8 @@ Here's a few primers if you are new to the PSR-2 coding standards:
 Don't worry, you don't have to know by heart the PSR-2 coding standards to start contributing to Friendica.
 There are a few tools you can use to check or fix your files before you commit.
 
+For documentation we use the standard of *one sentence per line* for the `md` files in the `/doc` and `/doc/$lng` subdirectories.
+
 ####Check with [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer)
 
 This tool checks your files against a variety of coding standards, including PSR-2, and ouputs a report of all the standard violations.