summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSjonHortensius <sjon@hortensius.net>2015-03-29 15:11:03 +0200
committerSjonHortensius <sjon@hortensius.net>2015-03-29 15:11:03 +0200
commit84c2d088d3eee490b04c8ed7ce6d2851e30e04c9 (patch)
treebd74a76eae11b5f68045b1f5ccf534b33fc87701 /README.md
parent50a93b16154eb57698986a05f4b7c2b2e3a17827 (diff)
downloadpfsense-84c2d088d3eee490b04c8ed7ce6d2851e30e04c9.zip
pfsense-84c2d088d3eee490b04c8ed7ce6d2851e30e04c9.tar.gz
Added bulletpoint about changing backend-code
fixes #33
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index 31a973b..b50abb7 100644
--- a/README.md
+++ b/README.md
@@ -3,13 +3,15 @@ pfSense on bootstrap (<a href="https://github.com/SjonHortensius/pfsense/blob/bo
We are migrating pfSense to Bootstrap. You can help! Please respect these code-guidelines:
-* use tabs (tabstop=4) for indenting (except the license-header which contains 3 lines that are indented with "\t<SP><SP><SP>")
+* use tabs (tabstop=4) for indenting (except the license-header which contains 3 lines that are indented with ```\t<SP><SP><SP>```)
* no trailing whitespace
* limited echoing of HTML from php, please use proper templating syntax instead (eg. foreach/endforeach)
-* limited attributes on elements; _no style attributes_
+* limited attributes on elements; so _**no** style/align/width attributes_
* no inline javascript
* html attributes should be using double-quoted attribute-values. This means your php-code should probably use single-quoted strings
* we use icons for status-indication and buttons for actions
+* **do not** refactor any of the 'backend' code that is on top of each file. Only changes necessary after updating are acceptable; any other changes will be rejected (including changes that were done upstream)
+* we accepth both [K&R](https://en.wikipedia.org/wiki/Indent_style#K.26R_style) and [ZF](http://framework.zend.com/manual/1.12/en/coding-standard.html) styled code, the above guidelines have a higher precedence
If you feel adventurous you can sometimes rewrite some PHP & javascript code as well; but try to keep this to a minimum.
OpenPOWER on IntegriCloud