Message Structure
In order to be recognized by Garfio, the commit message must follow this structure :
| Message section | Description | Format | Example |
|---|---|---|---|
| Header | It specifies the issue number | Issue #: < IssueNumber > | Issue #: 462 |
| Body | Message to be added to the issue as a note | Free text | DAO interface mock implementation |
| Actions | |||
| The issue has been resolved | @resolved | ||
| Time to be added to the issue worked hours field | @worked [+]time | @worked +3h20m | |
| @worked 5h | |||
| The product version where the issue has been resolved | @version numeroDeversion | @version 1.2 |
Examples
Adds a note to the issue #123 in the tracker
Issue #: 123 Add support for foo.
Marks the issue as resolved
Issue #: 123 Add support for foo. @resolved
Specifies that the issue required effort was 2 hours, 35 minutes
Issue #: 123 Add support for foo. @resolved @worked 2h 35m
Specifies that 4 hours should be added to the worked hours field
Issue #: 123 Add support for foo. @resolved @worked +4h
Specifies that the issue has been resolved in the product version 2.0.1
Issue #: 123 Add support for foo. @resolved @version 2.0.1