Changes between Version 3 and Version 4 of MarketEtiquette

Timestamp:

Jun 29, 2011, 12:37:00 AM (13 years ago)

Author:

YobiLab

Comment:

Just copied and pasted the very initial requirements. I will need more time to adjust the above requirements.

MarketEtiquette

@@ -4 +4 @@
 
 Discussion started here - http://www.boonex.com/n/development-etiquette 
+
+'''1) CSS coding way:'''
+
+Fonts, styles, colors, borders, buttons etc.. we have to use the default Dolphin classes. Many modules we made are using our own CSS classes. This will comport issues in the custom templates of the customers and it will always require an additional work on them. It always happens because every customer has or will have a custom template. So we need to use the Dolphin general CSS classes to make sure we will not have any incompatibility with the custom templates.
+
+Any other necessary class the CSS of the module will need to use, should not be coded in a way that will interfer with the general Dolphin CSS classes. It includes, but not exclusively: font colors, font sizes, font styles, borders, background colors-images, thumbnails modifications and in general any other attribute that will make a change in the custom template.
+
+'''2) PHP Coding way related to the Template system:'''
+
+-When creating new pages, in the Main section only the Content should be modded.
+
+-No changes are allowed on the designbox, only what is inside the content of the designbox should be modded.
+
+-The HTML code and the CSS code should not be Ever included in the PHP code. The HTML code and the CSS code should be written in the specific files.
+
+-We should not make floating Elements without having them placed in a specific container. Only lightboxes and similars are allowed to float wherever on the template.
+
+-When creating inputs, submit buttons and similars we should use the default Dolphin ones and not using our own classes with different backgrounds-images.
+
+-Modification on the scripts files should always be made inside the custom template and not in the base folder.
+
+-The customer should be always noticed of any change we have made on a Dolphin Default file. We will have to create a folder inside the server of the customer with a .TXT file where each of us should at least write where a change has been made and why.
+
+-Any of the above requirements are also mandatory for the modifications on any Boonex Module.
+
+'''3) PHP coding way:'''
+
+-No modifications of the Dolphin Default files are permitted. If any change on the default files is necessary then this change should be properly written in the .TXT file as explained above.
+
+-Every module should be coded in the way Boonex requires.
+
+-Installation of each module should be easy and should not include more than 1-2 steps for the customer when possible.
+
+-Insertions, Alterations and similars should be placed in the SQL file and should run only by the Dolphin Admin Panel.
+
+-PHP code should be written in a way that will not eat all the server resources. Each PHP code should be as much smarter as possible, the same applies for mySQL queries, insertions, alterations and similars.
+
+-Each module should always include the english language file. Each module should not have any missing language string. Also the languages strings should be written in a way that the customer will be able to easily modify them.