X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fcontributor%2Fissues.itexi;h=434ead511a139e1181b417f0cfb7997e4da18ae6;hb=f938685c1aa5af0316d762068577460c8fc663e6;hp=7ee9ef6009f97ea17212ad631b21cf1ee243ec5d;hpb=d88e54489f00d19ed207c2885522e62ed75a5f51;p=lilypond.git diff --git a/Documentation/contributor/issues.itexi b/Documentation/contributor/issues.itexi index 7ee9ef6009..434ead511a 100644 --- a/Documentation/contributor/issues.itexi +++ b/Documentation/contributor/issues.itexi @@ -1,4 +1,4 @@ -@c -*- coding: utf-8; mode: texinfo; -*- +Elu@c -*- coding: utf-8; mode: texinfo; -*- @node Issues @chapter Issues @@ -7,10 +7,10 @@ miscellaneous development tasks. @menu * Introduction to issues:: -* Bug Squad setup:: -* Bug Squad checklists:: +* The Bug Squad:: * Issue classification:: * Adding issues to the tracker:: +* Patch handling:: * Summary of project status:: @end menu @@ -18,127 +18,140 @@ miscellaneous development tasks. @node Introduction to issues @section Introduction to issues -@warning{Unless otherwise specified, all the tasks in this chapter -are @qq{simple} tasks: they can be done by a normal user with -nothing more than a web browser, email, and lilypond.} +@warning{All the tasks in this chapter require no programming skills and +can be done by anyone with a web browser, an email client and the +ability to run LilyPond.} -@qq{Issues} isn't just a politically-correct term for @qq{bug}. -We use the same tracker for feature requests and code TODOs, so -the term @qq{bug} wouldn't be accurate. Despite the difference -between @qq{issue} and @qq{bug}, we call our team of contributors -who organize issues the @emph{Bug Squad}. +The term @q{issues} refers not just to software bugs but also includes +feature requests, documentation additions and corrections as well as any +other general code @q{TODOs} that need to be kept track of. -The Bug Squad is mainly composed of non-programmers -- their job -is to @emph{organize} issues, not solve them. Their duties -include removing false bug reports, ensuring that any real bug -report contains enough information for developers, and checking -that a developer's fix actually resolves the problem. -New volunteers for the Bug Squad should contact the -@ref{Meisters, Bug Meister}. +@node The Bug Squad +@section The Bug Squad +@menu +* Bug Squad setup:: +* Bug Squad checklists:: +@end menu -@node Bug Squad setup -@section Bug Squad setup - -We highly recommend that you configure your email to use effective -sorting; this can reduce your workload @emph{immensely}. The -email folders names were chosen specifically to make them work if -you sort your folders alphabetically. +To help keep track and organize all issues are a group of tireless +volunteers collectively known as the @emph{Bug Squad}. Composed mainly +of non-programmers, the Bug Squad's responsibilities include: -@enumerate +@itemize @item -Skim through every section of this chapter, @ref{Issues}. Read in -detail any sections called @qq{Bug Squad...}, or any page linked -from @ref{Bug Squad checklists}. +Monitoring the LilyPond Bugs mailing list looking for any issues +reported by other users ensuring that they are accurate and contain +enough information for the developers to work with, preferably with +@rweb{Tiny examples} and if applicable, screenshots. @item -If you do not have one already, create a gmail account and send -the email address to the @ref{Meisters, Bug Meister}. +Adding new issues to the @emph{issue tracker} or updating existing +issues with new information. @item -Subscribe your gmail account to @code{bug-lilypond}. +Verifying issues in the @emph{issue tracker} that have been marked +as @q{fixed}; making sure either that the fix works or (in the case of +Documentation for example) has at least been commited to the code base. -@item -Configure your google code account: +@end itemize + +The @ref{Meisters, Bug Meister} also helps check the current +@ref{Regression tests} and highlights any significant changes (or +problems) since the previous LilyPond release. + +If you would like to be part of the Bug Squad, please contact the +@ref{Meisters, Bug Meister}. + + +@node Bug Squad setup +@subsection Bug Squad setup + +We highly recommend that you configure your email client to use some +kind of sorting and filtering as this will significantly reduce and +simplify your workload. Suggested email folder names are mentioned +below to work when sorted alphabetically. @enumerate @item -Wait until your gmail account is listed in: +Read every section of the @ref{Issues} chapter in this guide. -@example -@uref{http://code.google.com/p/lilypond/people/list} -@end example +@item +Subscribe your email account to @code{bug-lilypond}. See +@uref{https://lists.gnu.org/mailman/listinfo/bug-lilypond}. @item -Sign in to google code by clicking in the top-right corner of: +Send your email address to the @ref{Meisters, Bug Meister}. -@example -@uref{http://code.google.com/p/lilypond/issues/list} -@end example +@item +Create your own Sourceforge login (required for the Allura issue +tracker): -You cannot log if you have Google Sharing -@uref{http://www.googlesharing.net/} enabled. +@itemize @item -Go to your @qq{Profile}, and select @qq{Settings}. +Go to @uref{https://sourceforge.net/p/testlilyissues/issues/} @item -Scroll down to @qq{Issue change notification}, and make sure that -you have @emph{selected} @qq{If I starred the issue}. +Click on 'Join' in the top-right corner. -@end enumerate +@item +Fill in your details as required and click the @emph{Register} button to +complete the registration. + +@end itemize + +@item +Send your Sourceforge @emph{username} (not your email address) to +@email{bug-lilypond@@gnu.org} asking to be given appropriate permissions +to either create, edit and comment on tracker issues. @item Configure your email client: -@enumerate +@itemize @item -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}. +Any email sent with your address in the @code{To:} or @code{CC:} fields +should be configured to go into a @code{bug-answers} folder. @item -Any other email either from, or CC'd to, +Any email either @code{From:} or @code{CC:} to, @example -lilypond@@googlecode.com +testlilyissues-auto@@lists.sourceforge.net @end example @noindent -should go into a separate @code{bug-ignore} folder. Alternately, -you may automatically delete these emails. - -You will @strong{not read} these emails as part of your Bug Squad -duties. If you are curious, go ahead and read them later, but it -does @strong{not} count as Bug Squad work. +should be configured to go into a @code{bug-ignore} folder or, +alternately, configure your email client to delete these automatically. +You do @emph{not} need to read mails in the @code{bug-ignore} folder. +If you are curious (and have time) then read them, but they are not +necessary for Bug Squad work. @item -Any other email sent to (or CC'd to): +Any email sent @code{To:} or @code{CC:} to, @example bug-lilypond @end example @noindent -should go into a separate @code{bug-current} folder. +should be configured to go into a @code{bug-current} folder. -@end enumerate +@end itemize @end enumerate @node Bug Squad checklists -@section Bug Squad checklists +@subsection Bug Squad checklists When you do Bug Squad work, start at the top of this page and work -your way down. Stop when you've done 15 minutes. +your way down. Stop when you've done 20 minutes. Please use the email sorting described in @ref{Bug Squad setup}. This means that (as Bug Squad members) you will only ever respond @@ -148,24 +161,22 @@ to emails sent or CC'd to the @code{bug-lilypond} mailing list. @subsubheading Emails to you personally You are not expected to work on Bug Squad matters outside of your -15 minutes, but sometimes a confused user will send a bug report +20 minutes, but sometimes a confused user will send a bug report (or an update to a report) to you personally. If that happens, please forward such emails to the @code{bug-lilypond} list so that the currently-active Bug Squad member(s) can handle the message. -@subsubheading Daily schedule - -The Bug Meister is omitted from the daily schedule. +@subsubheading Daily schedule as of July 2015 @example -Sunday: Colin -Monday: Dmytro -Tuesday: James Bailey -Wednesday: Ralph -Thursday: Patrick -Friday: Urs -Saturday: Kieren +Monday: Federico Bruni +Tuesday: Simon Albrecht +Wednesday: Simon Albrecht +Thursday: Colin Campbell +Friday: Ralph Palmer +Saturday: Colin Campbell +Sunday: @end example @@ -315,61 +326,96 @@ After @strong{every release} (both stable and unstable): @itemize @item -Regression test comparison: if anything has changed suspiciously, -ask if it was deliberate. The official comparison is online, at: +Issues to verify: go to + +@smallexample +@uref{https://sourceforge.net/p/testlilyissues/issues/search/?q=status%3AFixed} +@end smallexample + +(You can also generate this list by selecting the @qq{Open (Fixed)} +button down the left-hand frame) + +You should see a list of Issues that have been marked as 'Fixed' by a +developer. If the developer has done their job properly, the +Issue should have the @qq{Labels} field filled in with @qq{Fixed_x_y_z}, +where X is the major version, y the minor version and z the current +release. -@c NOTE: leave this here. In this case, it's worth duplicating -@c the link. -gp @example -@uref{http://lilypond.org/test/} +Fixed_2_19_39 @end example -More information is available from in -@ref{Precompiled regression tests}. +This will help you work out which you can verify - do not verify any +Issues where the claimed fixed build is not yet released. Work your +way through these as follows: +If the Issue refers to a bug, try to reproduce the bug with the latest +officially released version (not one you've built yourself from +source); if the bug is no longer there, mark the +issue @qq{Verified} (i.e. @qq{the fix has been verified to work}). -@item -Issues to verify: try to reproduce the bug with the latest -version; if you cannot reproduce the bug, mark the item -@qq{Verified} (i.e. @qq{the fix has been verified to work}). +Quite a few of these will be issues tracking patches. @strong{You +do not have to prove these patches work - simply that they have +been pushed into the code base.} The developer should have put +information similar to @qq{Pushed as as +d8fce1e1ea2aca1a82e25e47805aef0f70f511b9} in the tracker. The +long list of letters and numbers is called the @qq{committish}. +Providing you can find this at the git tracker: @example -@uref{http://code.google.com/p/lilypond/issues/list?can=7} +@uref{http://git.savannah.gnu.org/gitweb/?p=lilypond.git} +@end example + +then you should mark the issue as verified. A quick way of +finding these is to enter the committish at the following address: + +@example +@uref{http://philholmes.net/lilypond/git/} @end example -A few (approximately 10%) of these fixed issues relate to the +The Issue tracker also requires that any issues labelled as +@qq{Duplicate} are also verified. Check that the linked issue is +a duplicate and verify the issue. + +A few (approximately 10%) of the 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 +@item +The official regression test comparison is online at: +@c NOTE: leave this here. In this case, it's worth duplicating +@c the link. -gp +@example +@uref{http://lilypond.org/test/} +@end example -@ignore -@c try omitting from daily tasks for now. -gp +If anything has changed suspiciously, +ask if it was deliberate. If the text output from LilyPond (the +logfile) changes, the differences will be displayed with a + +before text added to the logfile and - before any text removed +from the logfile. This may or may not be suspicious. -Once every @strong{two weeks} or so: +There is one test designed to produce output every time the +regtests are created. @code{test-output-distance.ly} creates +randomly spaced notes and will always have different output if the +regtest checker is working. -@itemize +More information is available from in +@ref{Precompiled regression tests}. @item Check for any incorrectly-classified items in the tracker. This generally just means looking at the grid to see any items without -a Type or Priority. - -@item -Check for any items with @code{label:patch}. If it's been more -than a week since the last action on the issue, send an email to --devel to remind them about it. If the patch was withdrawn for -more work, then remove the @code{patch} label. - -@example -@uref{http://code.google.com/p/lilypond/issues/list?can=2&q=label:patch} -@end example +a Type. @end itemize +@ignore +@c try omitting from daily tasks for now. -gp + @subheading Irregular maintenance @warning{These tasks are a lot of work; gathering more volunteers @@ -404,8 +450,8 @@ same (broken) output as the initial report, then simply post a @section Issue classification The Bug Squad should classify issues according to the guidelines -given by developers. Every issue should have a Status, Type, and -Priority; the other fields are optional. +given by developers. Every issue should have a Status and Type; +the other fields are optional. @subheading Status (mandatory) @@ -466,7 +512,23 @@ The issue's Type should be the first relevant item in this list. @itemize @item -Type-Collision: overlapping notation. +Type-Critical: normally a regression +against the current stable version or the previous stable version. +Alternatively, a regression against a fix developed for the +current version. This does not apply where the +@qq{regression} occurred because a feature was removed +deliberately - this is not a bug. + +Currently, only Critical items will block a stable release. + +@item +Type-Maintainability: hinders future development. + +@item +Type-Crash: any input which produces a crash. + +@item +Type-Ugly: overlapping or other ugly notation in graphical output. @item Type-Defect: a problem in the core program. (the @code{lilypond} @@ -490,12 +552,16 @@ Type-Enhancement: a feature request for the core program. The distinction between enhancement and defect isn't extremely clear; when in doubt, mark it as enhancement. +@item +Type-Patch: tracking a patch on Rietveld. Bug squad should not +need to use this label. + @item Type-Other: anything else. @end itemize - +@ignore @subheading Priority (mandatory) Currently, only Critical items will block a stable release. @@ -541,10 +607,53 @@ regression against an old stable version which hasn't been noticed for a long time and which is unlikely to get fixed could be downgraded from Priority-Critical by one of the programmers. +@end ignore + @subheading Opsys (optional) Issues that only affect specific operating systems. +@subheading Patch label (optional) + +Normal Bug Squad members should not add or modify Patch issues +except to verify them; for all other Patch work, leave them to the +Patch Meister. + +@itemize + +@item +Patch-new: the patch has not been checked for @qq{obvious} +mistakes. When in doubt, use this tag. + +@item +Patch-review: the patch has no @qq{obvious} mistakes (as checked +by the Patch Meister), and is ready for review from main +developers. + +Developers with git push ability can use this category, skipping +over @code{patch-new}. + +@item +Patch-needs_work: a developer has some concerns about the patch. +This does not necessarily mean that the patch must be changed; in +some cases, the developer's concerns can be resolved simply by +discussion the situation or providing notation examples. + +If the patch is updated, the category should be changed to +@code{patch-new} (for normal contributors) or @code{patch-review} +(for developers who are very confident about their patch). + +@item +Patch-countdown: final call for any patch problems + +@item +Patch-push: patch has passed the countdown and should be pushed. + +@item +Patch-abandoned: the author has not responded to review comments +for a few months. + +@end itemize @subheading Other items (optional) @@ -553,14 +662,14 @@ Other labels: @itemize @item -Regression: it used to work intentionally in an earlier -stable release. If the earlier output was accidental (i.e. we -didn't try to stop a collision, but it just so happened that two -grobs didn't collide), then breaking it does not count as a -regression. +Regression: it used to work intentionally in the current +stable release or the previous stable release. If the earlier +output was accidental (i.e. we didn't try to stop a collision, +but it just so happened that two grobs didn't collide), then +breaking it does not count as a regression. -To help decide whether the change is a regression, and therefore -should be Priority-Critical, please adopt the following process: +To help decide whether the change is a regression, please adopt +the following process: @enumerate @@ -569,30 +678,23 @@ Are you certain the change is OK? If so, do nothing. @item Are you certain that the change is bad? Add it to the tracker -as a Critical issue, regression. +as a regression. @item If you're not certain either way, add it to the tracker as a -Critical issue, regression but be aware that it may be -recategorised or marked invalid. +regression but be aware that it may be recategorised or marked +invalid. @end enumerate In particular, anything that breaks a regression test is a regression. -@item -Patch: a patch to fix an issue is attached. - @item Frog: the fix is believed to be suitable for a new contributor (does not require a great deal of knowledge about LilyPond). The issue should also have an estimated time in a comment. -@item -Maintainability: hinders development of LilyPond. For example, -improvements to the build system, or @qq{helper} python scripts. - @item Bounty: somebody is willing to pay for the fix. Only add this tag if somebody has offered an exact figure in US dollars or euros. @@ -605,15 +707,18 @@ to warnings when compiling the source code or generating documentation. @item -Security: might potentially be used. +Security: security risk. @item -Performance: might potentially be used. +Performance: performance issue. @end itemize If you particularly want to add a label not in the list, go -ahead, but this is not recommended. +ahead, but this is not recommended, except when an issue is marked +as fixed. In this case it should be labeled Fixed_mm_MM_ss, +where mm is major version, MM minor version and ss current +release. @node Adding issues to the tracker @@ -626,8 +731,6 @@ follow the guidelines for @rweb{Bug reports}.} In order to assign labels to issues, Bug Squad members should log in to their google account before adding an item. -@subsubheading Normal issues - @enumerate @item @@ -640,7 +743,7 @@ have been added. @item 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. +@code{Status} and @code{Type-} labels. Include output with the first applicable method: @@ -670,6 +773,18 @@ If the issue requires one or two pages of output, then generate a lilypond --png bug.ly @end example +@item +Images created as @file{bug.png} may be trimmed to a minimum size +by using the @code{trimtagline.sh} script, which can be found at + +@smallexample +@uref{https://raw.github.com/gperciva/lilypond-extra/master/bug-squad/trimtagline.sh} +@end smallexample + +@example +trimtagline.sh bug.ly +@end example + @item If the issue cannot be shown with less than three pages, then generate a @file{bug.pdf} file with: @@ -678,8 +793,8 @@ generate a @file{bug.pdf} file with: 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. +Note that this is likely to be extremely rare; most bugs should +fit into the first two categories above. @end itemize @@ -694,58 +809,94 @@ email should contain a link to the issue you just added. @end enumerate -@subsubheading Patch reminders +@node Patch handling +@section Patch handling @warning{This is not a Bug Squad responsibility; we have a separate person handling this task.} -There is a special category of issues: reminders of an existing -patch. These should be added if a patch has been sent to a -lilypond mailing list (generally @code{lilypond-devel}, but they -sometimes appear on @code{bug-lilypond} as well) and has had no -discussion for at least @strong{3 days}. Do not add issues for -patches under active discussion. +For contributors/developers: follow the steps in +@ref{Patches}, and @ref{Pushing to staging}. -Before adding a patch-reminder issue, do a quick check to see if -it was pushed without sending any email. This can be checked for -searching for relevant terms (from the patch subject or commit -message) on the webgit page: +@ignore +For people doing maintenance tasks: git-cl is adding issues, James +is testing patches and managing the Patch countdown. He also generally +runs the scripts that merging to Staging (although other developers are +available to do this task if required). +@end ignore -@example -@uref{http://git.savannah.gnu.org/gitweb/?p=lilypond.git} -@end example -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 -was sent to multiple mailing lists (such as both @code{bugs} and -@code{devel}), then reply to all those mailing lists as well. The -email should contain a link to the issue you just added. +@node Summary of project status +@section Summary of project status +@subsubheading Project overview +Project activity -@node Summary of project status -@section Summary of project status +@smallexample +@uref{https://sourceforge.net/projects/testlilyissues/} +@end smallexample -The best overview of our current status is given by the grid view: +@subsubheading Hindering development -@example -@uref{http://code.google.com/p/lilypond/issues/list?mode=grid&y=Priority&x=Type&cells=ids} -@end example +These issues stop or slow development work: -Also of interest might be the issues hindering future development: +@smallexample +@uref{https://sourceforge.net/p/testlilyissues/issues/search/?q=status:Accepted%20AND%20_type:Maintainability} +@end smallexample -@example -@uref{http://code.google.com/p/lilypond/issues/list?can=2&q=label:Maintainability&mode=grid&y=Priority&x=Type&cells=ids} -@end example +@subsubheading Easy tasks + +Issues tagged with @code{Frog} indicates a task suitable for a +relatively new contributor. The time given is a quick (and probably +inaccurate) estimate of the time required for somebody who is familiar +with material in this manual, but does not know anything else about +LilyPond development. + +@smallexample +@uref{https://sourceforge.net/p/testlilyissues/issues/search/?q=status:Accepted%20AND%20labels:Frog} +@end smallexample + +@subsubheading Patches currently in the Patch Review cycle + +Overview -Finally, issues tagged with @code{Frog} indicates a task suitable -for a relatively new contributor. The time given is a quick -(inaccurate) estimate of the time required for somebody who is -familiar with material in this manual, but does not know anything -else about LilyPond development. +@c The following URL is provided by one of the Developers giving a much +@c easier way to see all patches at all stages of the Review cycle in a +@c single place. @example -@uref{http://code.google.com/p/lilypond/issues/list?can=2&q=label:Frog&mode=grid&y=Priority&x=Type&cells=ids} +http://philholmes.net/lilypond/allura/ @end example +@noindent +New patches + +@smallexample +@uref{https://sourceforge.net/p/testlilyissues/issues/search/?q=status%3AStarted+AND+_patch%3Anew} +@end smallexample + + +@noindent +Patches under Review + +@smallexample +@uref{https://sourceforge.net/p/testlilyissues/issues/search/?q=status%3AStarted+AND+_patch%3Areview} +@end smallexample + + +@noindent +Patches on final Countdown + +@smallexample +@uref{https://sourceforge.net/p/testlilyissues/issues/search/?q=status%3AStarted+AND+_patch%3Acountdown} +@end smallexample + + +@noindent +Patches that can be pushed + +@smallexample +@uref{https://sourceforge.net/p/testlilyissues/issues/search/?q=status%3AStarted+AND+_patch%3Apush} +@end smallexample