]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/contributor/issues.itexi
Merge branch 'master' into lilypond/translation
[lilypond.git] / Documentation / contributor / issues.itexi
index 72509d080f72c0172afe2166e7cce1b150f6c3b4..4260e838ad02b9339fde2bf594cca85bb6702fb5 100644 (file)
@@ -58,18 +58,31 @@ from @ref{Bug Squad checklists}.
 If you do not have one already, create a gmail account and send
 the email address to the @ref{Meisters, Bug Meister}.
 
+@item
+Subscribe your gmail account to @code{bug-lilypond}.
+
 @item
 Configure your google code account:
 
 @enumerate
 
 @item
-Log in to:
+Wait until your gmail account is listed in:
 
 @example
-@uref{http://code.google.com}
+@uref{http://code.google.com/p/lilypond/people/list}
 @end example
 
+@item
+Sign in to google code by clicking in the top-right corner of:
+
+@example
+@uref{http://code.google.com/p/lilypond/issues/list}
+@end example
+
+You cannot log if you have Google Sharing
+@uref{http://www.googlesharing.net/} enabled.
+
 @item
 Go to your @qq{Profile}, and select @qq{Settings}.
 
@@ -88,6 +101,10 @@ Configure your email client:
 Any email sent with your gmail address in the @code{To:} or
 @code{CC:} fields should go to a @code{bug-answers} folder.
 
+When setting up your filtering rules, be aware that Google Code
+might use different versions of your email address, such as ones
+ending in @code{@@googlemail.com} or @code{@@gmail.com}.
+
 @item
 Any other email either from, or CC'd to,
 
@@ -140,13 +157,15 @@ the currently-active Bug Squad member(s) can handle the message.
 
 @subsubheading Daily schedule
 
+The Bug Meister is omitted from the daily schedule.
+
 @example
-Sunday: Valentin
+Sunday: Colin
 Monday: Dmytro
 Tuesday: James Bailey
 Wednesday: Ralph
-Thursday: Phil Holmes
-Friday: Urs Liska, Patrick
+Thursday: Patrick
+Friday: Urs
 Saturday: Kieren
 @end example
 
@@ -186,7 +205,7 @@ check to see who else has replied to it), delete it.
 
 @item
 If the email is a question about how to use LilyPond, reply with
-this reponse:
+this response:
 
 @example
 For questions about how to use LilyPond, please read our
@@ -195,6 +214,11 @@ documentation available from:
 or ask the lilypond-user mailing list.
 @end example
 
+@item
+If the email mentions @qq{the latest git}, or any version number
+that has not yet been officially released, forward it to
+@code{lilypond-devel}.
+
 @item
 If a bug report is not in the form of a Tiny example, direct the
 user to resubmit the report with this response:
@@ -206,7 +230,6 @@ step 2 in our bug reporting guidelines:
   @uref{http://lilypond.org/website/bug-reports.html}
 @end example
 
-
 @item
 If anything is unclear, ask the user for more information.
 
@@ -215,7 +238,7 @@ What version of lilypond was used (if not given) and operating
 system (if this is a suspected cause of the problem)?  In short,
 if you cannot understand what the problem is, ask the user to
 explain more.  It is the user's responsibility to explain the
-problem, not your reponsibility to understand it.
+problem, not your responsibility to understand it.
 
 @item
 If the behavior is expected, the user should be told to read the
@@ -315,6 +338,11 @@ version; if you cannot reproduce the bug, mark the item
 @uref{http://code.google.com/p/lilypond/issues/list?can=7}
 @end example
 
+A few (approximately 10%) of these fixed issues relate to the
+build system or fundamental architecture changes; there is no way
+for you to verify these.  Leave those issues alone; somebody else
+will handle them.
+
 @end itemize
 
 
@@ -364,7 +392,7 @@ information is available from in @ref{Regression tests}.
 @item
 Checking all issues: we try to mark each Issue @q{fixed} when we
 fix it, but occasionally one or two issues will slip through the
-cracks.  It is therefore good to check all Issues. If you see the
+cracks.  It is therefore good to check all Issues.  If you see the
 same (broken) output as the initial report, then simply post a
 @qq{Problem still exists in 2.x.y} message to the issue.
 
@@ -457,6 +485,7 @@ includes the makefiles, stepmake, python scripts, and GUB.
 @item
 Type-Scripts: problem or desired feature in the non-build-system
 scripts.  Mostly used for convert-ly, lilypond-book, etc.
+
 @item
 Type-Enhancement: a feature request for the core program.  The
 distinction between enhancement and defect isn't extremely clear;
@@ -475,37 +504,38 @@ Currently, only Critical items will block a stable release.
 @itemize
 
 @item
-Priority-Critical: lilypond segfaults, or a regression occurred
-within the last two stable versions.  (i.e. when developing 2.13,
-any regression against 2.12 or 2.10 counts)
+Priority-Critical: LilyPond segfaults, a regression against a
+previous stable version or a regression against a fix developed
+for this version.  This does not apply where the @qq{regression}
+occurred because a feature was removed deliberately - this is not
+a bug.
 
 @item
-Priority-High: highly embarrassing items, and any regression
-against a version earlier than two stable versions (i.e. when
-developing 2.13, any regression against 2.8 or earlier).  This
-level is also used for issues which produce no output and fail to
-give the user a clue about what's wrong.
+Priority-High: An issue which produces output which does not
+accurately reflect the input (e.g. where the user would expect
+an accidental, but none is shown) or which produces aesthetically
+poor output in a situation which could be expected to crop up
+frequently in real-world music.  It should not be used where the
+problem can be avoided with a simple workaround.  It can also
+be used to flag where new code in a development version is not
+functioning as it should.  This level is also used for issues
+which produce no output and fail to give the user a clue about
+what's wrong.
 
 @item
-Priority-Medium: normal priority.
+Priority-Medium: Normal priority - use this as the default.
 
 @item
-Priority-Low: less important than normal.
+Priority-Low: A minor problem which produces slightly undesirable
+output, or which will only occur in contrived examples, or which
+is very easily worked around.
 
 @item
 Priority-Postponed: no fix planned.  Generally used for things
-like Ancient notation, which nobody wants to touch.
+which nobody wants to touch.
 
 @end itemize
 
-The difference between Priority-Medium and Priority-Low is not
-well-defined, both in this policy and in practice.  The only
-answer we can give at the moment is @qq{look at existing items in
-of the same type, and try to guess whether the priority is closer
-to the Medium items or Low items}.  We're aware of the ambiguity,
-and won't complain if somebody picks a @q{wrong} value for
-Medium/Low.
-
 
 @subheading Opsys (optional)
 
@@ -534,7 +564,7 @@ Frog: the fix is believed to be suitable for a new contributor
 issue should also have an estimated time in a comment.
 
 @item
-Maintainability: hinders developent of LilyPond.  For example,
+Maintainability: hinders development of LilyPond.  For example,
 improvements to the build system, or @qq{helper} python scripts.
 
 @item
@@ -556,7 +586,7 @@ Performance: might potentially be used.
 
 @end itemize
 
-If you particularly want to add an label not in the list, go
+If you particularly want to add a label not in the list, go
 ahead, but this is not recommended.
 
 
@@ -586,6 +616,48 @@ Add the issue and classify it according to the guidelines in
 @ref{Issue classification}.  In particular, the item should have
 @code{Status}, @code{Type-}, and @code{Priority-} labels.
 
+Include output with the first applicable method:
+
+@itemize
+
+@item
+If the issue has a notation example which fits in one system,
+generate a small @file{bug.preview.png} file with:
+
+@example
+lilypond -dpreview bug.ly
+@end example
+
+@item
+If the issue has an example which requires more than one system
+(i.e. a spacing bug), generate a @file{bug.png} file with:
+
+@example
+lilypond --png bug.ly
+@end example
+
+@item
+If the issue requires one or two pages of output, then generate a
+@file{bug.png} file with the normal:
+
+@example
+lilypond --png bug.ly
+@end example
+
+@item
+If the issue cannot be shown with less than three pages, then
+generate a @file{bug.pdf} file with:
+
+@example
+lilypond --pdf bug.ly
+@end example
+
+Note that this is likely to be extremely rare; most bugs should fit
+into the first two categories above.
+
+
+@end itemize
+
 @item
 After adding the issue, please send a response email to the same
 group(s) that the initial patch was sent to.  If the initial email