Engage Code Review

[Michelle D'Souza]

Hi everyone,

Several of us met in Breeze today to do a code review of engage core  
for the 0.1 release. Some of the findings of the review were fixed  
today as part of code cleanup. Others were filed in JIRA for future  
fixing. The following are tasks that we either need to discuss more or  
file in JIRA but they will not hold up the 0.1 release.

Let the QA begin!

Michelle



ant build
  * consider minifying everything instead of just 'engage-core'

cabinet
  * the toggleVisibility function might be able to be refactored and  
simplified
  * look at refactoring toggleDrawers, moveDrawers, openDrawer and  
closeDrawer for code clarity

description
  * find a more general name for the component
  * generalize the removal of tags since data cleanup is likely useful  
everywhere
  * think about whether or not we need the renderer for this component
  * consider alternatives to markup injection
  * images need to be organized in their themes
  * CSS needs to be split up by theme

navigation list
  * public API - decide if it needs one and otherwise turn it into a  
little component
  * remove engage stuff from nav list
  * the css is for a navigation list that is inside a cabinet - where  
does the code belong?

browse
   * tests need to move into correct folders

tags
  * should tags be a rendered component?
  * the component shouldn't have title anymore
  * make tags into a little component
  * merge the templates

general
  * change the paths in the HTML files so they are relative within  
engage-core
  * comment the public API and interesting private functions
  * come up with a testing strategy for kettle
  * more tests for everything within engage core




------------------------------------------------------
Michelle D'Souza
Software Developer, Fluid Project
Adaptive Technology Resource Centre
University of Toronto