crossley 02/05/25 06:25:17
Modified: src/documentation/xdocs/howto howto-bugzilla.xml
Log:
Sync content changes with Forrest. There is a copy of this document there
now as one of the Demonstration How-To docs.
Revision Changes Path
1.2 +105 -103 xml-cocoon2/src/documentation/xdocs/howto/howto-bugzilla.xml
Index: howto-bugzilla.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/howto/howto-bugzilla.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- howto-bugzilla.xml 17 May 2002 12:37:26 -0000 1.1
+++ howto-bugzilla.xml 25 May 2002 13:25:17 -0000 1.2
@@ -2,38 +2,42 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"../dtd/document-v10.dtd">
<document>
- <header>
- <title>How to Contribute a Patch via Bugzilla</title>
- <version>0.1</version>
- <authors>
- <person name="David Crossley" email="[EMAIL PROTECTED]"/>
- </authors>
+ <header>
+ <title>How to Contribute a Patch via Bugzilla</title>
+ <version>0.1</version>
+ <authors>
+ <person name="David Crossley" email="[EMAIL PROTECTED]"/>
+ </authors>
</header>
<body>
<s1 title="Overview">
-
<p>
Bugzilla is the Internet-based mechanism to facilitate contributions to any
-Apache project. This includes changes to code and changes to documents
-(Patches), and also reports of bugs and suggestions for enhancement.
-In this How-to, we are concentrating on providing a Patch. Perhaps another
-How-to will describe adding a full Bug report, though this document will get
-you started.
+Apache project. This includes changes to code and documents
+(Patches), and also reports of flaws in the system (Bugs), and suggestions
+for enhancement.
</p>
<p>
-We will explain how to create your Bugzilla account, how to enter a patch
-description, and finally how to attach the actual patch file.
+In this How-to we will concentrate on the Patch tracking capabilities of
+Bugzilla. We will explain how to create your genereal Bugzilla account,
+how to enter a patch description, and finally how to attach the actual patch
+file.
</p>
</s1>
<s1 title="Intended Audience">
<p>
-This document is meant for first-time users.
-The Bugzilla interface can be daunting, so this is a concise explanation of
-how to start. Once you can do that, you can proceed to make more substantial
-contributions. Of course, it concentrates only on Cocoon contributions.
+This document is meant for first-time users of Bugzilla.
+The web interface can be daunting, so this concise explanation will help
+you to start. After your first patch submission, you can proceed to make more
+substantial contributions.
+</p>
+
+<p>
+As our example we use the contribution of a simple documentation patch for
+the Apache Cocoon project. The principles apply to any project.
</p>
</s1>
@@ -45,7 +49,7 @@
<li>Understand what a Patch is and how to make one.
<!-- See <link href="howto-patch.html">How to Prepare a Patch</link> -->
See <link href="">How to Prepare a Patch</link> (Doc under development).
-Note that a new complete document is still just a patch.
+Note that a new complete document is still just a "patch".
</li>
<li>Understand that Bugzilla is the Apache Bug Database. Bugzilla does not
distinguish between a Bug report, a Patch submission, and an Enhancement
suggestion. They are all <em>"Bugs"</em> as far as Bugzilla is concerned.
@@ -61,143 +65,144 @@
in another browser window.
</p>
- <s2 title="1. Open a Bugzilla Account" >
+ <s2 title="1. Create your Bugzilla Account">
<p>
-Follow the online instructions from the home page. Do not worry, you will
-not be sent spam email nor bombarded with advertisements.
+Follow the link the home page to "Open a new Bugzilla account".
+Do not worry, you will not be sent spam email nor bombarded with advertisements
+by setting up this account. It is purely a workgroup tool.
</p>
<p>
Note that you can conduct queries in Bugzilla and review submissions without
having an account. However, to make a contribution you must have an account.
-This ensures legitimacy. It also enables the system to automatically send you
-email when your patch is applied by a Cocoon committer.
+This ensures legitimacy. It also enables the system to send you
+email automatically when your patch is applied by a Cocoon committer.
</p>
</s2>
- <s2 title="2. Enter a new bug report" >
+ <s2 title="2. Enter a new bug report">
<p>
-Choose that link from the Bugzilla home page. You will be asked to first
-select the relevant project ... choose Cocoon 2 of course. Next you will be
-asked to provide your account details. Following that you will be presented
-an input form for the various details ...
+Follow the "Enter a new bug report" link from the Bugzilla home page. First,
+you will be asked to select the relevant project ... choose Cocoon 2 of course.
+Next, you will be asked to provide your account details. Following that, you
+will be presented an input form for the various details ...
</p>
+
</s2>
- <s2 title="3. Specify Version" >
+ <s2 title="3. Specify Version">
<p>
-This is the version of Cocoon that you prepared your patch against. Use the
-default <code>Current CVS</code> if you have an up-to-date local working copy
+This is the version of Cocoon that you prepared your patch against. Choose
+<code>Current CVS</code> if you have an up-to-date local working copy
of HEAD branch or a very recent nightly build. Otherwise choose the relevant
-release version.
+release version. This is a very important step, as you will confuse the
+committer if your changes do not match the repository. If you are unsure, then
+please say so in the description at step 12.
</p>
</s2>
- <s2 title="4. Specify Component" >
+ <s2 title="4. Specify Component">
<p>
Follow the "Component" link for description of the available
-components. If you do not know which component then just use <code>core</code>.
+components. If you do not know which component is relevant, then just use
+<code>core</code>.
</p>
</s2>
- <s2 title="5. Specify Platform" >
+ <s2 title="5. Specify Platform">
<p>
-Really meant for bug reporting. Perhaps it could be relevant for a patch.
-You would usually specify the <code>All</code> option.
+This is really meant for bug reporting. Perhaps it could be relevant for a
+patch. You would usually specify the <code>All</code> option.
</p>
</s2>
- <s2 title="6. Specify Operating System" >
+ <s2 title="6. Specify Operating System (OS)">
<p>
Really meant for bug reporting. Perhaps it could be relevant for a patch.
You would usually specify the <code>All</code> option.
</p>
</s2>
- <s2 title="7. Specify Severity" >
+ <s2 title="7. Specify Severity">
<p>
-The impact that would arise from not applying the patch. For a documentation
+The impact that would arise if your patch is not applied. For a documentation
patch, the severity would usually be the default <code>Normal</code>.
However, if it addressed some serious lack or fixed a misguided configuration
statement, then the impact could be <code>major</code>.
</p>
<p>
(The <code>enhancement</code> option would not be used for a patch, as it is
-intended for suggesting something that should be done. Use this wisely. It
-would be better to discuss it on the mailing list first, and when clear then
-describe it.)
+intended for suggesting something that should be done. Use this option wisely.
+It would be better to discuss it on the mailing list first.)
</p>
</s2>
- <s2 title="8. Specify Initial State" >
+ <s2 title="8. Specify Initial State">
<p>
Use the <code>New</code> option.
</p>
</s2>
- <s2 title="9. Specify Assigned To" >
+ <s2 title="9. Specify Assigned To">
<p>
-Leave it blank. It will be automatically assigned to the
+Leave it blank. Your patch will be automatically assigned to the
<code>cocoon-dev</code> mailing list. When a committer takes on your patch,
-they will assign the bug to themselves. This pevents duplication of effort by
-other committers.
+that committer will assign the bug to their own email address. This pevents
+duplication of effort by other committers.
</p>
<p>
-The Cc field can be used if you need to have the bug reports, and any
-follow-up, copied to some other person. Remember that the posting will get
-automatically sent to the <code>cocoon-dev</code> mailing list, so no need to
-Cc anyone there.
+The Cc field can be used if you need the bug reports, and any follow-up, to be
+copied to some other person. Remember that your report will be sent
+automatically to the <code>cocoon-dev</code> mailing list, so you do not need
+to Cc anyone there.
</p>
</s2>
- <s2 title="9. Specify URL" >
+ <s2 title="10. Specify URL">
<p>
If the patch refers to a particular document, then provide the website URL.
-If it a refers to an issue with one of the local Cocoon Samples, then provide
+If it refers to an issue with one of the local Cocoon Samples, then provide
the localhost URL.
</p>
</s2>
- <s2 title="9. Carefully choose the Summary" >
+ <s2 title="11. Carefully choose the Summary">
<p>
-This will become the all-important title of the bug. Use it wisely. You want
+The summary will become the all-important title of the bug. Use it wisely. You want
to draw attention to your patch. Just as with posting email to the listervers,
-if you choose a poor title then your posting can be easily overlooked.
+choosing a poor title may cause your posting to be easily overlooked.
Use up all the characters available ... about 60 maximum.
</p>
<p>
-Start the Summary with the <code>[PATCH]</code> tag. This will enable the
-Cocoon automated patch queue summary to the mailing lists to remind people what
-patches are pending. If you do not do this then your patch could easily be
-overlooked.
+Start the Summary with the <code>[PATCH]</code> tag. This will ensure that it
+is included in the Cocoon automated patch queue summary posted to the mailing
+lists. The patch queue summary reminds people what patches are pending. If you
+omit this tag, then your patch may easily be overlooked.
</p>
</s2>
- <s2 title="10. Description" >
+ <s2 title="12. Description">
<p>
Provide a brief explanation of what your patch does. Supply any instructions
to help the committer apply your patch efficiently. Note any issues that may
remain. It may help to list each file that you are submitting and briefly
-describe what it is.
-</p>
-<p>
-The committer will need to provide a descriptive log message when they commit
-your work. Your clear description will help them.
+describe what it is. A committer will need to provide a descriptive log message
+when committing your work. Providing a clear description here will help them.
</p>
<p>
-You might already have the Description and Summary text written before you
-start entering the patch report. Perhaps save it in a local text file
-beforehand, and then copy-and-paste it when the time comes.
+Consider writing the Description and Summary text before you start entering
+your patch report. You could save it in a local text file beforehand and
+then copy-and-paste it when the time comes.
</p>
<p>
-If this was a bug report, then it would need extensive description.
+If this were a bug report, then it would need extensive description.
</p>
</s2>
- <s2 title="11. Send the patch report" >
+ <s2 title="13. Send the patch report">
<p>
Review your options, then press the <strong>Commit</strong> button. This will
-add an entry to the bug database and send email to the
+add an entry to the bug database and email a report to the
<code>cocoon-dev</code> mailing list and a copy to you. Your submission will be
assigned a unique Bug Number which you can use to review its progress.
</p>
@@ -207,7 +212,7 @@
</p>
</s2>
- <s2 title="12. Create an attachment of the actual patch" >
+ <s2 title="14. Create an attachment of the actual patch">
<p>
You will be presented with a status screen saying that your bug report
was accepted and that email was sent to <code>cocoon-dev</code> mailing list.
@@ -216,32 +221,29 @@
<p>
Now you have a choice ... proceed to review your bug report by selecting the
link "Back to Bug #XXXXX". If you forgot to mention something,
-then you can add more comments. From that screen you can follow the link
+then you can add more comments. From that screen, follow the link
"Create a new attachment".
-</p>
-
-<p>
Otherwise follow the link from this status screen to "Attach a file to
this bug".
</p>
</s2>
- <s2 title="13. Specify the file to be uploaded" >
+ <s2 title="15. Specify the file to be uploaded">
<p>
Provide the local pathname to your patchfile, e.g.
<code>/home/me/work/cocoon/patch/howto-bugzilla.tar.gz</code>
</p>
</s2>
- <s2 title="14. Describe the attachment" >
+ <s2 title="16. Describe the attachment">
<p>
Provide a concise one line description, e.g.
<code>Gzipped TAR archive with new docs and diffs</code>
</p>
</s2>
- <s2 title="15. Specify the contentType of the attachment" >
+ <s2 title="17. Specify the contentType of the attachment">
<p>
If it is a Gzipped TAR archive (*.tar.gz) or a .zip archive, then select
"<code>Binary file (application/octet-stream)</code>".
@@ -252,49 +254,48 @@
</p>
</s2>
- <s2 title="15. Submit the attachment" >
+ <s2 title="18. Submit the attachment">
<p>
-When you are ready, press the <strong>Submit</strong> button. As for Step 11,
+When you are ready, press the <strong>Submit</strong> button. As for Step 13,
you will be presented with a status screen saying that your attachment
was accepted and that email was sent to <code>cocoon-dev</code> mailing list.
</p>
</s2>
- <s2 title="16. Be patient" >
+ <s2 title="19. Be patient">
<p>
-Now your patch will wait inside Bugzilla, until one of the Cocoon committers
-assigns the patch to themselves and starts to process it and apply it to the
-master CVS repository. You will be sent automatic email at each of these stages
-because you are the registered owner of the Bug.
+Now your patch will wait inside Bugzilla until one of the Cocoon committers
+assigns the patch to their own email address and starts to process it to apply
+it to the master CVS repository. As the registered owner of the Bug, you will
+be sent an automatic email at each of these stages.
</p>
</s2>
- <s2 title="17. Add more description or attachments if necessary" >
+ <s2 title="20. Add more description or attachments if necessary">
<p>
Until the patch is applied by the committer and the Bug report is closed, you
-can still add more to your bug report. However, only do this if it is
-absolutely necessary because the committer does not want the patch to be
-changing while they are trying to commit it. If it is just further changes
-that you want to make, then it would be better to wait until your patch is
+can still add more to your bug report. However, only do this when
+absolutely necessary because the patch should not be
+changing while the committer is trying to commit it. If you just want to make
+further changes, then it would be better to wait until your patch is
applied. Then you can make a new patch. Remember that the committer has full
veto and may decide to make some slight modifications to your patch. So it
is far better to wait.
</p>
</s2>
- <s2 title="18. Adding subsequent patches to the same document or program" >
+ <s2 title="21. Adding subsequent patches to the same document or program">
<p>
If you want to make more patches to the same file, then please open a new Bug
-rather than re-open the old one. After all, the original patch is already
-applied by the committer and the Bug report is closed.
+rather than re-open the old one. After all, once the original patch is
+applied by the committer, its corresponding Bug report is closed.
</p>
</s2>
</s1>
- <s1 title="Extension">
-<note>Author note: Help ... not sure what the
-<strong>extension</strong> section is for.</note>
+ <s1 title="Real World Extension">
+<p>Contributing patches, in the form of documentation or code, is a vital way to
give back to the Cocoon community. For example, you might consider contributing a
timely patch in the form of a new FAQ, how-to, or tutorial. Or, you may also consider
submitting a patch which updates Cocoon's existing user and developer guides. </p>
</s1>
<s1 title="Tips">
@@ -315,8 +316,9 @@
<s2 title="Search Bugzilla">
<p>
-There is a very powerful search interface. Now that you have a login account,
-Bugzilla can remember your specific queries and you can run them with a click.
+Bugzilla has a very powerful search interface. Now that you have a login
+account, Bugzilla can remember customized queries which you can run with a
+single click.
</p>
</s2>
@@ -329,7 +331,7 @@
<link
href="http://nagoya.apache.org/bugzilla/";>http://nagoya.apache.org/bugzilla/</link>
</li>
<li>
-There are very helpful Bug Writing Guidelines available directly from the
+Helpful Bug Writing Guidelines are available directly from the
Bug entry interface.
</li>
</ul>
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
