| Prev | Chapter�12.�Engineering Standards | Next |
|---|
+ ">
By Jeff Davis -
+
Why have coding standards for OpenACS? And if the code works why change it to adhere to some arbitrary rules?
@@ -27,7 +27,7 @@ over a long period by a lot of different people, OpenACS sometimes lacks this basic guessability and in the interest of bringing it into line we have advanced these guidelines. -
Here is a short list of the basic rules code contributed to OpenACS should follow...
Follow the file naming and the package structure rules.� @@ -74,8 +74,8 @@ toolkit more useful for everyone and more easily extended.
Make sure your datamodel create/drop scripts work.�
Break the table creation out from the package/stored
- procedure creation and use create or
- replace where possible so that scripts
+ procedure creation and use create or
+ replace where possible so that scripts
can be sourced more than once. Make sure your drop script
works if data has been inserted (and permissioned and
notifications have been attached etc).
@@ -89,6 +89,6 @@
Solicit code reviews.� Ask others to look over your code and provide feedback and do the same for others. -