git.roojs.org Git - web.mtrack/blob - defaults/help/plugin/CommitCheckTimeRef

   1 = MTrackCommitCheck_RequiresTimeReference =
   2
   3 When this plugin is enabled, it prevents commits from taking place if the
   4 commit does not reference a ticket and include time tracking information.
   5
   6 An example of the time reference is shown below, which adds 3.5 hours of effort
   7 to ticket #123:
   8
   9 {{{
  10 Compensate for the foo issue; it was hard to track down.
  11 refs #123 (spent 3.5)
  12 }}}
  13
  14 If the commit does not reference a ticket, it will be denied.
  15
  16 The log message may reference multiple tickets; this plugin does not require
  17 that every referenced ticket have an effort associated with it, so long as at
  18 least one ticket has effort tracked, the commit will be allowed.
  19
  20 == configuration ==
  21
  22 {{{
  23 [plugins]
  24 MTrackCommitCheck_RequiresTimeReference =
  25 }}}
  26