Generate HTML documentation using MkDocs (WIP)

[github/shaarli/Shaarli.git] / doc / md / Development-guidelines.md

diff --git a/doc/md/Development-guidelines.md b/doc/md/Development-guidelines.md
new file mode 100644 (file)
index 0000000..1480ec8
--- /dev/null
+++ b/doc/md/Development-guidelines.md
@@ -0,0 +1,9 @@
+## Development guidelines
+
+Please have a look at the following pages:
+- [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md)
+- [[Static analysis]] - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially:
+    - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard
+    - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide
+- [[Unit tests]]
+- [[GnuPG signature]] for tags/releases