summaryrefslogtreecommitdiffstatshomepage
path: root/doc/developers/rules
diff options
context:
space:
mode:
authorGravatar Christian Weiske2011-05-26 08:20:04 +0200
committerGravatar Christian Weiske2011-05-26 08:20:04 +0200
commit18989f97f1c4299f447b011c28961ca5c8310c13 (patch)
tree3ecf5ac1572f064d461209514d1568f216536839 /doc/developers/rules
parentb279ded75769818ae78ca11654ecef935d6cb956 (diff)
downloadscuttle-18989f97f1c4299f447b011c28961ca5c8310c13.tar.gz
scuttle-18989f97f1c4299f447b011c28961ca5c8310c13.zip
documentation index
Diffstat (limited to 'doc/developers/rules')
-rw-r--r--doc/developers/rules30
1 files changed, 0 insertions, 30 deletions
diff --git a/doc/developers/rules b/doc/developers/rules
deleted file mode 100644
index 701a215..0000000
--- a/doc/developers/rules
+++ /dev/null
@@ -1,30 +0,0 @@
-Rules for developers
-====================
-
-1. Coding style
----------------
-SemanticScuttle uses the PEAR Coding Standards.
-While quite some parts still do not follow them, all of the
-code will be coverted to them. When developing new code,
-adhere to it.
-
-A helpful tool to check your coding style is PHP CodeSniffer,
-http://pear.php.net/package/PHP_CodeSniffer
-
-
-2. Unit tests
--------------
-At least the service and model classes have unit tests.
-If you fix things in there, make sure you
-a) do not break the tests or
-b) fix the tests if the old behavior was broken
-
-
-3. Keep security in mind
-------------------------
-As a web application, there are several attack vectors to SemanticScuttle.
-When processing user input (form variables, URL parameters)
-be sure to convert and validate them. If you expect a bookmark id,
-there is no reason not to cast the variable to (int).
-
-Filter input, escape output.