Difference between revisions of "Attn: Engine Programmers"
From Whirlwind eCommerce Wiki
(New page: =Notes= ;Never save any script without writing notes as per this section ;All changes to code me notated in three places *At the line preceding all lines of code that are changed in a scr...) |
(changed readme.doc to history.txt) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 5: | Line 5: | ||
*At the line preceding all lines of code that are changed in a script | *At the line preceding all lines of code that are changed in a script | ||
*At the top of the script in the history notes. Always reference the location of the changes (i.e. the function name or the process being performed 'looping through products') | *At the top of the script in the history notes. Always reference the location of the changes (i.e. the function name or the process being performed 'looping through products') | ||
| − | *In the root | + | *In the root history.txt file in the history notes. Always reference the script path in the readme |
| − | ;All notes should take the following format: | + | |
| − | Date : Your name : Reference Location : Notes | + | ;All notes should take the following format: <i>Date : Your name : Reference Location : Notes</i> |
Examples (for each code location as specified above): | Examples (for each code location as specified above): | ||
*1/25/2009: Mark Wexler: Commented out following line and added line below it to fix 'subtotal' bug | *1/25/2009: Mark Wexler: Commented out following line and added line below it to fix 'subtotal' bug | ||
*1/25/2009: Mark Wexler: orderGetSummary(): fixed 'subtotal' bug | *1/25/2009: Mark Wexler: orderGetSummary(): fixed 'subtotal' bug | ||
*1/25/2009: Mark Wexler: /common/fnOrder.php: fixed 'subtotal' bug | *1/25/2009: Mark Wexler: /common/fnOrder.php: fixed 'subtotal' bug | ||
Latest revision as of 08:18, 7 February 2009
Notes
- Never save any script without writing notes as per this section
- All changes to code me notated in three places
- At the line preceding all lines of code that are changed in a script
- At the top of the script in the history notes. Always reference the location of the changes (i.e. the function name or the process being performed 'looping through products')
- In the root history.txt file in the history notes. Always reference the script path in the readme
- All notes should take the following format
- Date : Your name : Reference Location : Notes
Examples (for each code location as specified above):
- 1/25/2009: Mark Wexler: Commented out following line and added line below it to fix 'subtotal' bug
- 1/25/2009: Mark Wexler: orderGetSummary(): fixed 'subtotal' bug
- 1/25/2009: Mark Wexler: /common/fnOrder.php: fixed 'subtotal' bug
