[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
web: rephrase bugreports section (issue 5698070)
From: |
janek . lilypond |
Subject: |
web: rephrase bugreports section (issue 5698070) |
Date: |
Sun, 26 Feb 2012 16:49:12 +0000 |
Reviewers: ,
Message:
Please review.
Description:
web: rephrase bugreports section
According to Graham's favorite rule ("perfection is attained
when there's nothing more to delete") i'm rephrasing bugreports
section hoping to make it even more brief and straightforward
for all users.
Please review this at http://codereview.appspot.com/5698070/
Affected files:
M Documentation/web/community.itexi
Index: Documentation/web/community.itexi
diff --git a/Documentation/web/community.itexi
b/Documentation/web/community.itexi
index
a6af03f96cd7ac64de4cdbe6f4f711b575209de5..f3a15c60754df3ef372bfec86b8634d3002be488
100644
--- a/Documentation/web/community.itexi
+++ b/Documentation/web/community.itexi
@@ -390,20 +390,23 @@ quite often 4 lines are enough to demonstrate the
problem!
@node Bug reports
@unnumberedsec Bug reports
+
address@hidden
+If you have input that results in a crash or wrong output,
+then that is a bug.
address@hidden
+
@divClass{column-center-top}
@subheading Step 1: Known bugs
-If you have input that results in a crash or an erroneous output,
-then that is a bug. There is a list of current bugs on our google
-bug tracker,
+We may already know about this bug. Check here:
@example
@uref{http://code.google.com/p/lilypond/issues/list}
@end example
address@hidden @strong{DO NOT} add bug reports directly to the
-bug tracker. Once an issue has been added to the tracker, feel
-free to add more information to that report.}
address@hidden @strong{DO NOT} add bug reports to the
+bug tracker yourself.}
@divEnd
@@ -411,12 +414,12 @@ free to add more information to that report.}
@divClass{column-left-bottom}
@subheading Step 2: Creating a bug report
-If you have discovered a bug which is not listed, please help us
-by creating a bug report.
+If you have discovered a bug which is not listed,
+please help us by creating a bug report.
address@hidden only accept bug reports in the form of
address@hidden examples}. We have very limited resources to deal with
-bug reports, so any non-minimal example will be rejected. Almost
address@hidden only accept reports in the form of
address@hidden examples}. We have very limited resources,
+so any non-minimal example will be rejected. Almost
every bug can be demonstrated in four notes or less!}
Here is an example of a good bug report:
@@ -473,13 +476,14 @@ report.
@divClass{column-center-bottom}
@subheading Step 4: Wait for a response
-Once your bug has been sent to the list, our Bug Squad will
-examine the report. Please allow up to 4 days, as we have a
-limited number of volunteers for this task. They may ask you for
-more information, or may add the report to the tracker and let you
-know what the issue number is.
+Once your bug report has been sent to the list, our Bug Squad will
+examine it; they may ask you for more information. You will be notified
+when the report will be added to the bug tracker. Please allow up to 4
days,
+as we have a limited number of volunteers for this task.
-You may mark the bug so that you automatically receive emails when
+Once a bug has been added to the tracker, you can comment it to add
+more information about it.
+You may also mark the bug so that you automatically receive emails when
any activity on the bug occurs. This requires you have a google
account.
@divEnd
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- web: rephrase bugreports section (issue 5698070),
janek . lilypond <=