[Slony1-commit] slony1-www bug-processing.html

Wed Aug 18 11:45:43 PDT 2010

Update of /home/cvsd/slony1/slony1-www
In directory main.slony.info:/tmp/cvs-serv14030

Modified Files:
	bug-processing.html 
Log Message:
Add a "work flow perpective"

Index: bug-processing.html
===================================================================
RCS file: /home/cvsd/slony1/slony1-www/bug-processing.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -C 2 -d -r1.4 -r1.5
*** bug-processing.html	18 Aug 2010 16:50:30 -0000	1.4
--- bug-processing.html	18 Aug 2010 18:45:41 -0000	1.5
***************
*** 23,27 ****

    <body>
!   <table border="0" cellpadding="2" cellspacing="0" width="100%">
      <tbody>
        <tr>
--- 23,27 ----

    <body>
!   <table width="100%" border="0" cellspacing="0" cellpadding="2">
      <tbody>
        <tr>
***************
*** 30,35 ****
              <tbody>
                <tr>
!                 <td align="left" valign="top"><img src=
!                 "images/Slon_450x320.jpg" align="left"></td>

                  <td align="left" valign="top"></td>
--- 30,34 ----
              <tbody>
                <tr>
!                 <td align="left" valign="top"><img src="images/Slon_450x320.jpg" alt="" align="left"></td>

                  <td align="left" valign="top"></td>
***************
*** 38,79 ****
            </table>

!           <table border="0" cellpadding="2" cellspacing="0" width=
!           "100%">
              <!-- if proj id not empty display proj nav -->

              <tbody>
                <tr bgcolor="#000000">
!                 <td colspan="2"><img src="images/shim.gif" height=
!                 "1" width="1"></td>

!                 <td><img src="images/shim.gif" height="1" width=
!                 "1"></td>
                </tr>

                <tr bgcolor="#EEEEEE">
!                 <td nowrap="nowrap"><img src="images/shim.gif"
!                 height="1" width="1"><b><a class="adminNav" href=
!                 "admin.html">Project Admin Area</a></b></td>

                  <td align="right" nowrap="nowrap" width="100%">
!                 <b><a class="projNav" href=
!                 "http://main.slony.info">slony1 Home</a> |
!                 <a class="projNav" href=
!                 "http://slony.info/">Slony-I Website</a> |
                  <a class="projNav" href="git.html">Git Info</a>
!                 | <a class="projNav" href=
!                 "http://lists.slony.info/mailman/listinfo">Mailing
                  Lists</a></b></td>

!                 <td><img src="images/shim.gif" height="1" width=
!                 "1"></td>
                </tr>

                <tr bgcolor="#000000">
!                 <td colspan="2"><img src="images/shim.gif" height=
!                 "1" width="1"></td>

!                 <td><img src="images/shim.gif" height="1" width=
!                 "1"></td>
                </tr>
              </tbody>
--- 37,67 ----
            </table>

!           <table width="100%" border="0" cellspacing="0" cellpadding="2">
              <!-- if proj id not empty display proj nav -->

              <tbody>
                <tr bgcolor="#000000">
!                 <td colspan="2"><img src="images/shim.gif" alt="" height="1" width="1"></td>

!                 <td><img src="images/shim.gif" alt="" height="1" width="1"></td>
                </tr>

                <tr bgcolor="#EEEEEE">
!                 <td nowrap="nowrap"><img src="images/shim.gif" alt="" height="1" width="1"><b><a class="adminNav" href="admin.html">Project Admin Area</a></b></td>

                  <td align="right" nowrap="nowrap" width="100%">
!                 <b><a class="projNav" href="http://main.slony.info">slony1 Home</a> |
!                 <a class="projNav" href="http://slony.info/">Slony-I Website</a> |
                  <a class="projNav" href="git.html">Git Info</a>
!                 | <a class="projNav" href="http://lists.slony.info/mailman/listinfo">Mailing
                  Lists</a></b></td>

!                 <td><img src="images/shim.gif" alt="" height="1" width="1"></td>
                </tr>

                <tr bgcolor="#000000">
!                 <td colspan="2"><img src="images/shim.gif" alt="" height="1" width="1"></td>

!                 <td><img src="images/shim.gif" alt="" height="1" width="1"></td>
                </tr>
              </tbody>
***************
*** 82,130 ****
  		<h1>Slony-I Bug Processing</h1>

! 		<p> Slony bug tracking is being managed using <a
! 		href="http://www.bugzilla.org/"> Bugzilla.</a></p>

  		<p> Here is the <a href="http://www.slony.info/bugzilla/"> Slony-I
! 		Bugzilla Instance </a>.

  		<h1> Bug Management Process </h1>

! 		 <a href=
! 		"http://www.slony.info/bugzilla/docs/en/html/lifecycle.html"> Bug
! 		Lifecycle Documentation </a> uses the following image <img
! 		src="http://www.slony.info/bugzilla/docs/en/images/bzLifecycle.png">
 		to characterize the flow of work on bugs, through various states, as
! 		they (hopefully!) get fixed.

! 		 The following interpretations are suggested.

  		<h2> NEW </h2>
! 		<a name="NEW">

! 		 When a bug is created, it is created with NEW state, is
 		assigned to <tt>slony1-bugs at lists.slony.info</tt>, and an email is
! 		sent to the bug tracking list.

! 		 At this point, someone on the Slony development team should
 		examine the bug to ascertain what, if anything, should be done with
! 		it.

! 		<P> It may be appropriate to:
  		<ul>

<li> Assign it to someone that is expected to work on it, changing the
! 		owner, and change the status to <a href="#ASSIGNED">ASSIGNED</A>.

<li> Perhaps the bug is trivially resolved, in which case, it is
! 		reasonable to jump straight to marking it <a
! 		href="#RESOLVED">RESOLVED</a>.

! 		<li> Perhaps the bug is invalid. Jump straight to <a href=
! 		"#RESOLVED">RESOLVED</a>.

<li> Perhaps it is unclear who should work on it. Perhaps the bug
! 		should be left alone, or perhaps it should be <a
! 		href="#ASSIGNED">ASSIGNED</A> to someone who might know who
! 		should do the work.
 		</ul>

--- 70,112 ----
  		<h1>Slony-I Bug Processing</h1>

! 		 Slony bug tracking is being managed using <a href="http://www.bugzilla.org/"> Bugzilla.</a>

  		<p> Here is the <a href="http://www.slony.info/bugzilla/"> Slony-I
! 		Bugzilla Instance </a>.</p>

  		<h1> Bug Management Process </h1>

! 		 <a href="http://www.slony.info/bugzilla/docs/en/html/lifecycle.html"> Bug
! 		Lifecycle Documentation </a> uses the following image <img src="http://www.slony.info/bugzilla/docs/en/images/bzLifecycle.png" alt="">
 		to characterize the flow of work on bugs, through various states, as
! 		they (hopefully!) get fixed.

! 		 The following interpretations are suggested.

  		<h2> NEW </h2>
! 		<a name="NEW"></a>

! 		 When a bug is created, it is created with NEW state, is
 		assigned to <tt>slony1-bugs at lists.slony.info</tt>, and an email is
! 		sent to the bug tracking list.

! 		 At this point, someone on the Slony development team should
 		examine the bug to ascertain what, if anything, should be done with
! 		it.

! 		<p> It may be appropriate to:</p>
  		<ul>

<li> Assign it to someone that is expected to work on it, changing the
! 		owner, and change the status to <a href="#ASSIGNED">ASSIGNED</a>.</li>

<li> Perhaps the bug is trivially resolved, in which case, it is
! 		reasonable to jump straight to marking it <a href="#RESOLVED">RESOLVED</a>.</li>

! 		<li> Perhaps the bug is invalid. Jump straight to <a href="#RESOLVED">RESOLVED</a>.</li>

<li> Perhaps it is unclear who should work on it. Perhaps the bug
! 		should be left alone, or perhaps it should be <a href="#ASSIGNED">ASSIGNED</a> to someone who might know who
! 		should do the work.</li>
 		</ul>

***************
*** 132,209 ****

  		<h2> ASSIGNED </h2>
! 		  <a name="ASSIGNED">

! 		 This is the state of bugs that belong to someone. That
 		someone should presumably be a human, and not
! 		<tt>slony1-bugs at lists.slony.info</tt>.

  		<h2> RESOLVED </h2>
! 		  <a name="RESOLVED">

! 		 This is the state of bugs that have been addressed, after some
! 		fashion.

! 		 There are several possible resolutions:
 		<ul>
! 		<li> FIXED - believed to be resolved
! 		<li> DUPLICATE - this apparently duplicates some previous bug
! 		<li> WONTFIX - a problem that we don't plan to address
! 		<li> WORKSFORME - the developer can't duplicate the issue
! 		<li> INVALID - the problem is considered part of the proper behaviour of Slony
 		</ul>

! 		 Note that this is not the end of the lifecycle!

! 		 If a developer has a patch for a complex issue, it is appropriate to:
 		<ul>
! 		<li> Attach a patch, or perhaps a reference to a Git commit for the proposed fix.
! 		<li> Mark the bug RESOLVED/FIXED
 		<li> Reassign the bug, either to:
 		 <ul>
! 		 <li> The person that reported the bug
! 		 <li> The <tt>slony1-bugs at lists.slony.info</tt> user
! 		 <li> A specific Slony developer that is to validate the fix as <a name="#VERIFIED"> VERIFIED</a>
! 		 </ul>
 		</ul>

  		<h2> VERIFIED </h2>
! 		  <a name="VERIFIED">

! 		 A developer (or user) takes a <a href="#RESOLVED">RESOLVED</a> bug, and evaluates
! 		whether the resolution provided is proper.

! 		 The same resolution values apply:
 		<ul>
! 		<li> FIXED - believed to be resolved
! 		<li> DUPLICATE - this apparently duplicates some previous bug
! 		<li> WONTFIX - a problem that we don't plan to address
! 		<li> WORKSFORME - the developer can't duplicate the issue
! 		<li> INVALID - the problem is considered part of the proper behaviour of Slony
 		</ul>

! 		 At this point, for complex patches, we can consider that the patch
! 		has been verified to be valid to be committed and released.

! 		 The bug might be re-assigned back to the original developer to do
! 		the commit. But wait, it's not <a href="#CLOSED">CLOSED</a> yet...

! 		<H2> CLOSED </h2>
! 		  <a name="CLOSED">

! 		 The final destination for a Slony bug is for it to be closed. The
 		fix should have passed through phases of being <a href="#ASSIGNED">
 		ASSIGNED</a> <a href="#RESOLVED"> RESOLVED</a> <a name="#VERIFIED">
 		VERIFIED</a>. For particularly simple bugs, or for issues considered
! 		to not really be bugs, these phases may be rather brief.

! 		 A bug being marked CLOSED should indicate that we have put
 		it into some specific release, and placed a suitable reference into
! 		the release notes.

! 		<H2> REOPENED </h2>

! 		<P> Oh, no, the <b>zombie bug!</b>

! 		<P> Sometimes bugs aren't solved in the first attempt, and need to be
  		reopened.  This is pretty much equivalent to <a href="#ASSIGNED">
! 		ASSIGNED</a>.
--- 114,244 ----

  		<h2> ASSIGNED </h2>
! 		  <a name="ASSIGNED"></a>

! 		 This is the state of bugs that belong to someone. That
 		someone should presumably be a human, and not
! 		<tt>slony1-bugs at lists.slony.info</tt>.

  		<h2> RESOLVED </h2>
! 		  <a name="RESOLVED"></a>

! 		 This is the state of bugs that have been addressed, after some
! 		fashion.

! 		 There are several possible resolutions:
 		<ul>
! 		<li> FIXED - believed to be resolved</li>
! 		<li> DUPLICATE - this apparently duplicates some previous bug</li>
! 		<li> WONTFIX - a problem that we don't plan to address</li>
! 		<li> WORKSFORME - the developer can't duplicate the issue</li>
! 		<li> INVALID - the problem is considered part of the proper behaviour of Slony</li>
 		</ul>

! 		 Note that this is not the end of the lifecycle!

! 		 If a developer has a patch for a complex issue, it is appropriate to:
 		<ul>
! 		<li> Attach a patch, or perhaps a reference to a Git commit for the proposed fix.</li>
! 		<li> Mark the bug RESOLVED/FIXED</li>
 		<li> Reassign the bug, either to:
 		 <ul>
! 		 <li> The person that reported the bug</li>
! 		 <li> The <tt>slony1-bugs at lists.slony.info</tt> user</li>
! 		 <li> A specific Slony developer that is to validate the fix as <a name="#VERIFIED"> VERIFIED</a></li>
! 		 </ul></li>
 		</ul>

  		<h2> VERIFIED </h2>
! 		  <a name="VERIFIED"></a>

! 		 A developer (or user) takes a <a href="#RESOLVED">RESOLVED</a> bug, and evaluates
! 		whether the resolution provided is proper.

! 		 The same resolution values apply:
 		<ul>
! 		<li> FIXED - believed to be resolved</li>
! 		<li> DUPLICATE - this apparently duplicates some previous bug</li>
! 		<li> WONTFIX - a problem that we don't plan to address</li>
! 		<li> WORKSFORME - the developer can't duplicate the issue</li>
! 		<li> INVALID - the problem is considered part of the proper behaviour of Slony</li>
 		</ul>

! 		 At this point, for complex patches, we can consider that the patch
! 		has been verified to be valid to be committed and released.

! 		 The bug might be re-assigned back to the original developer to do
! 		the commit. But wait, it's not <a href="#CLOSED">CLOSED</a> yet...

! 		<h2> CLOSED </h2>
! 		  <a name="CLOSED"></a>

! 		 The final destination for a Slony bug is for it to be closed. The
 		fix should have passed through phases of being <a href="#ASSIGNED">
 		ASSIGNED</a> <a href="#RESOLVED"> RESOLVED</a> <a name="#VERIFIED">
 		VERIFIED</a>. For particularly simple bugs, or for issues considered
! 		to not really be bugs, these phases may be rather brief.

! 		 A bug being marked CLOSED should indicate that we have put
 		it into some specific release, and placed a suitable reference into
! 		the release notes.

! 		<h2> REOPENED </h2>

! 		<p> Oh, no, the <b>zombie bug!</b></p>

! 		 Sometimes bugs aren't solved in the first attempt, and need to be
 		reopened. This is pretty much equivalent to <a href="#ASSIGNED">
! 		ASSIGNED</a>.
! 
! 		<h1> Alternative Perspective </h1>
! 
! 		 Here is how one might expect a typical bug to pass through
! 		the system.
! 
! 		<ul>
! 
! 			 <li> Bug is reported on the mailing list</li>
! 
! 			 <li> Developer copies this over to Bugzilla, creating a
! 			 <a href="#NEW"> NEW</a> bug.</li>
! 
! 			 <li> Developer is reviewing the bug list, and sees a bug
! 				they wish to claim. They change its status to <a
! 				 href="#ASSIGNED"> ASSIGNED</a>, and assign themself as the
! 				owner.
! 
! 			 <li> Work continues apace. 
! 
! 			 <li> The developer has a proposed patch, which is
! 				assigned to its own Git "topic branch" on their
! 				repository.
! 
! 				 The developer attaches a link to this patch, or
! 				perhaps a copy of the patch, to the bug, and marks it
! 				<a href="#RESOLVED"> RESOLVED+FIXED</a>
! 
! 			 <li> Some verification takes place. Ideally, another
! 				developer confirms that the fix does what it ought to.
! 				Perhaps additional changes go into the patch.
! 
! 			 <li> Consensus is arrived at that the patch is good to
! 				go into one or more branches of Slony-I.
! 				<ul>
! 				 
! 				 <li> The patch is applied to those branches, and
! 				 committed.
! 				 
! 				 <li> Notes about the bug are added to the release
! 				 notes, and committed. 
! 
! 				 <li> They add indication to the bug of application
! 				 of the changes, so readers know what version(s) of
! 				 Slony-I may be expected to have this fix.
! 
! 				 <li> The bug is marked <a href="#CLOSED">
! 					 CLOSED.</a>
! 					
! 				</ul>
! 			</ul>
! 
! </td></tr></tbody></table></body></html>
\ No newline at end of file