Skip to content

Commit requirements

mage-core-team edited this page Mar 7, 2013 · 3 revisions

Format of comment

<ACTIVITY> <TASK_NUMBER>: <TASK_DESCRIPTION> 
<[EXTRA_DESCRIPTION]>
Where:
    ACTIVITY
        Fixed
        Implemented
        Re-factored
        CR Change(s) (CR - Code Review)
        Added
        Deleted
    TASK_NUMBER
        for example - MAGE-4567
    TASK_DESCRIPTION
        Issue or task subject in tracking tool
        Short description of changes
    EXTRA_DESCRIPTION - OPTIONAL
        Information about code re-factoring (methods, properties or classes were marked deprecated, etc)
        Comments about changed logic

Text Formating

Any structural part (ACTIVITY, TASK_DESCRIPTION or EXTRA_DESCRIPTION) of comment should start from capital letter.

Each part of EXTRA_DESCRIPTION should start from new line, leading "-" (minus with space) characters and capital letter at the begin of sentence.

Messages should correspond English grammar and contain only valid ASCII symbols.

Example of usage

Fixed MAGE-4567: Dataflow error after importing products
- Added check for fake products.
- Optimized methodName().
- Added "@deprecated after 1.7.0.2" mark for deprecatedMethodName() in Mage_Dataflow_Model_Import
Something went wrong with that request. Please try again.