Bug Checking Process

    Table of contents
    1. 1. Overview
    2. 2. Methodology
      1. 2.1. Principles
      2. 2.2. Techniques
      3. 2.3. ChangeLogs
      4. 2.4. Releases
    3. 3. Related

    Overview

    The following spec provides the methodology for checking in bugfixes.

    Methodology

    This methodoligy defines a clear way to differentiate bugs in order to support ongoing feature development as well as fixing any defects in previous revisions of MindTouch.

    Principles

    Bugs will be divided into the following categories:

    • Defects
    • New Feature

    All defects will have the following prefix in the bug title:  "DEFECT:".  For example: 0008861: DEFECT: index rtf files

    All other bugs are considered new development.  For example: 0008860: Print to pdf: Should take a path to a custom stylesheet, also support html output mode for debugging

    Techniques

    Bugs categorized as defects will be applied first to the latest stable branch (ex: /public/dekiwiki/10.0).  After commiting the change to the stable branch, changes will be forward ported to the trunk branch (/public/dekiwiki/trunk).

     

    Bugs categorized as a new feature will be checked into the trunk branch (/public/dekiwiki/trunk).  Feature bugs will NOT be backported into the stable branch.

    ChangeLogs

    A ChangeLog file will be maintained for each branch.  This file will exist at the root of the branch (ex:  /public/dekiwik/trunk/ChagneLog).  As part of each checkin, the ChangeLog file will need to be modified to specify the change made for the current checkin.

     

    TODO: Define the exact format of the ChangeLog file.  The final ChangeLog format is TBD.  Developers can continue checking in changes as normal and PeteE will review the SVN log to create the proper ChangeLog entry once the format has been finalized.

     

    Releases

    At the end of each 2 week iteration, a determination will be made whether the iteration will result in a release candidate for a major release or a point release of the current stable release (or both).  The SVN revision number of the last change in the itreation will be captured and communicated to the community (via a blog post).  Customers or community members who wish to run the latest iteration will update to the provided revision number in our SVN tree (ex: updateWiki.sh -r 12345).

    Related

    Tag page
    Viewing 2 of 2 comments: view all
    I think it would be nice if we can programmatically generate the Changelog -- maybe something like:

    ====
    (svn checkin message)
    Bugfix #1234: Added some new feature
    CHANGELOG: Implemented the cool new feature X, which allows for Y and Z
    ====

    And we can have a simple script to generate the ChangeLog for each release.
    Posted 14:57, 28 Sep 2010
    I agree with kalid's sentiments here. I think updating the changelog for stable should be a manual process, but the change log for trunk could easily be an automated process before we push out the release.
    - Isolate checkins to /trunk
    - Generate change log from svn commits

    Having to update the changelog for all commits is going to be prone to errors.
    Posted 12:22, 1 Oct 2010
    Viewing 2 of 2 comments: view all
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by