How to create a sample developer log entry

One of the most basic tasks that a developer or even one of our designers or UI/UX integrator must undertake (yes, we’re large enough to have these…) is logging and documenting what they may have changed in a development project, basecamp, CVS or other system.

Here is an example of a log (info changed to protect the innocent (website)

Developer: Thomas Granger

2-28-05:          Installed 2.2 Code base for OSC.

3-1-05:                        Configured OSC Store, Tax tables and administration

3-2-05:                        Installed USAePAY SDK and MID/TIDs, modified Code base :

Added to : /ecatalog/admin/includes/functions/general.php:

// Alias function for Store configuration values in the Administration Tool

function tep_cfg_select_multioption($select_array, $key_value, $key = '') {

for ($i=0; $i<sizeof($select_array); $i++) {

$name = (($key) ? 'configuration[' . $key . '][]' : 'configuration_value');

$string .= '<br><input type="checkbox" name="' . $name . '" value="' . $select_array[$i] . '"';

$key_values = explode( ", ", $key_value);

if ( in_array($select_array[$i], $key_values) ) $string .= ' CHECKED';

$string .= '> ' . $select_array[$i];

}

$string .= '<input type="hidden" name="' . $name . '" value="--none--">';

return $string;

}

////

3-2-05: Customization of common OSC templates, no build changes.

That’s it!

Want to discuss a project?

  • This field is for validation purposes and should be left unchanged.