code review process checklist by vintage
TRANSCRIPT
GENERAL RULES
• DO NOT INSERT CSS STYLES ANYWHERE OTHER THAN APPLICATION.CSS (MELON) OR SCREEN.CSS / ASSETBUNDLES (YII2)
• DO NOT INSERT JS-CODE ANYWHERE OTHER THAN APPLICATION.JS (MELON) OR JS FILES, CONNECTED TO ASSETBUNDLES (YII2)
• DO NOT EXECUTE DATABASE DRAWS INSIDE VIEWS. ALL DRAWS MUST BE PERFORMED IN MODELS / CONTROLLERS / WIDGETS
• DO NOT EXECUTE DATABASE INQUIRIES INSIDE CYCLES. CREATE DRAWING CONDITIONS CRITERIA INSTEAD.
• AVOID STING CONCATENATION IN LINKS. CREATE LINKS ONLY WITH INNATE TOOLS: YII – CREATEURL (YII1) OR URL (YII2) CLASS METHODS
ORGANIZATIONAL RULES
• IF THE PROJECT USES THEMES, ALL VIEWS EXCEPT FOR WIDGETS MUST BE STORED IN THE THEME FOLDER
• INSTEAD OF CDBCRITERIA, USE MELON BUILT-IN SCOPES• AVOID DUBBING CODE CHAINS. ALL DUBBING PARTS MUST BE TAKEN OUT TO
SEPARATE METHODS / CLASSES / ACTIONS / WIDGETS• FOR PROCESSING OF LARGE AMOINT OF DATA, USE CDATAPROVIDERITERATOR
(YII1) OR
FOR (YII2)ActiveRecord::find()->batch(10)
COMPONENTS INSTALLATION RULES
• USE ONLY COMPOSER COMMANDS FOR ADDITION OF NEW LIBRARIES / EXTENSIONS. IT IS THE ONLY FITTING INSTRUMENT TO MAINTAIN, UPDATE OR ALTER THE PROJECT’S DEPENDABLES
• ON YOUR LOCAL MACHNE, USE EITHER COMPOSER UPDATE OR COMPOSER INSTALL
• IN PRODUCTION, USE ONLY COMPOSER INSTALL. THIS COMMAND WILL INSTALL IDENTICAL VERSIONS OF ALL LIBRARIES, STORED IN COMPOSER.LOCK
CHECK TOOLS INSTRUCTIONS
FOR AUTO CODE STYLE CHECK IN PHPSTORM: • INSTALL PHP_CODESNIFFER
• INSTALL PHP_MESSDETECT
• IN PHPSTORM SETTINGS, CONFIGURE EDITOR -> CODE STYLE -> PHP -> SET FROM -> PREDEFINED STYLES: PSR-1/PSR-2
• FOR (YII1), TICK THE USE TABS BOX• FOR (YII2), LEAVE IT ON DEFAULT
$ pear install PHP_CodeSniffer
$ pear channel-discover pear.phpmd.org$ pear channel-discover pear.pdepend.org$ pear install --alldeps phpmd/PHP_PMD
