Documentation/devel/issues.itexi

   1 @c -*- coding: us-ascii; mode: texinfo; -*-
   2 @node Issues
   3 @chapter Issues
   4
   5 @menu
   6 * Introduction to issues::
   7 * Issue classification::
   8 * Adding issues to the tracker::
   9 @end menu
  10
  11
  12 @node Introduction to issues
  13 @section Introduction to issues
  14
  15 First, @qq{issue} isn't just a politically-correct term for
  16 @qq{bug}.  We use the same tracker for feature requests and code
  17 TODOs, so the term @qq{bug} wouldn't be accurate.
  18
  19 Second, the classification of what counts as a bug vs. feature
  20 request, and the priorities assigned to bugs, are a matter of
  21 concern @strong{for developers only}.  If you are curious about
  22 the classification, read on, but don't complain that your
  23 particular issue is higher priority or counts as a bug rather than
  24 a feature request.
  25
  26
  27 @node Issue classification
  28 @section Issue classification
  29
  30 Status values:
  31
  32 @itemize
  33
  34 @item
  35 New: the item was added by a non-member.  Should be reviewed by
  36 the Bug Meister.
  37
  38 @item
  39 Accepted: the Bug Meister added it, or reviewed the item.
  40
  41 @item
  42 Started: a programmer is working on a bugfix.  (used infrequently,
  43 but should be used more often)
  44
  45 @end itemize
  46
  47 Closed status values:
  48
  49 @itemize
  50
  51 @item
  52 Invalid: issue should not have been added in the current state.
  53
  54 @item
  55 Duplicate: issue already exists in the tracker.
  56
  57 @item
  58 Fixed: programmer claims to have fixed the bug.  The Bug Meister
  59 should check the input code in an official binary release.
  60
  61 @item
  62 Verified: Bug Meister has confirmed that the issue is closed.
  63
  64 @end itemize
  65
  66 Type labels:
  67
  68 @itemize
  69
  70 @item
  71 Type-Defect: a problem that requires no (or very little) new code
  72 to fix.
  73
  74 @item
  75 Type-Enhancement: a problem (or new feature) that requries a
  76 significant amount of new code.
  77
  78 @item
  79 Type-Collision: overlapping notation.  (this label takes
  80 precedence over -Defect and -Enhancement)
  81
  82 @item
  83 Type-Task: not used, I think.  TODO: start using it or delete it.
  84
  85 @item
  86 Type-Other: anything else.  TODO: start using it or delete it.
  87
  88 @end itemize
  89
  90 Priority labels:
  91
  92 @itemize
  93
  94 @item
  95 Priority-High: lilypond segfaults.
  96
  97 @item
  98 Priority-Regression: it used to work.
  99
 100 @item
 101 Priority-Medium: normal priority; this is the highest priority a
 102 non-crashing, non-regression bug report can receive.
 103 (irregardless of the perceived importance)
 104
 105 @item
 106 Priority-Low: less important than normal.
 107
 108 @item
 109 Priority-Postponed: no fix planned.  Generally used for things
 110 like Ancient notation, which nobody wants to touch.
 111
 112 @end itemize
 113
 114 Opsys lables: pretty self-explanatory.
 115
 116 Other lables:
 117
 118 @itemize
 119
 120 @item
 121 Security: not used.  TODO: delete, unless anybody is serious about
 122 this.
 123
 124 @item
 125 Performance: not used.  TODO: delete.
 126
 127 @item
 128 Usability: not used.  TODO: delete.
 129
 130 @item
 131 Maintainability: hinders developent of LilyPond.  For example,
 132 improvements to the build system, or @qq{helper} python scripts.
 133
 134 @item
 135 Bounty: somebody is willing to pay for the fix.
 136
 137 @item
 138 Engraving-nitpick: output is not beautiful, but not strictly
 139 speaking @qq{wrong}.  For example, a slur shape which does not
 140 collide with any notation, but looks ugly.
 141
 142 @item
 143 Warning-nitpick: graphical output is fine, but lilypond prints a
 144 false/misleading warning message.
 145
 146 @end itemize
 147
 148
 149 @node Adding issues to the tracker
 150 @section Adding issues to the tracker
 151
 152 FIXME: prettify.
 153
 154 only done by Bug Meister, unless you're really certain you know
 155 what you're doing.
 156
 157
 158
 159
 160