README

Gitbug is an in-repo bug tracker for Git repositories.


Installation:

  0. Install ocamlfind, omake and the OCaml libraries pcre and netstring.
    On a Debian/Ubuntu:
    $ sudo apt-get install libocamlnet-ocaml-dev libpcre-ocaml-dev omake ocaml-findlib

  1. Compile
    $ omake

  2. Copy the executable to somewhere in your path
    $ cp gitbug.opt ~/bin/gitbug

Usage:

  List of commands:
    $ gitbug help

  You need a Git repository:
    $ mkdir my_git_repo
    $ cd my_git_repo
    $ git init
    $ echo buggy foo > foo
    $ git add foo
    $ git commit -m 'buggy foo'

  Then you should initialize the bug tracker:
    $ gitbug init

  And add a bug:
    $ gitbug add This is my first bug

  Maybe look at it and edit it:
    $ gitbug
    -- Open bugs
    444468c69994_This_is_my_first_bug       2009-02-16 15:39:18+0200

    $ gitbug show .*first 
    $ gitbug edit .*first

  Gitbug treats the pattern as a regexp prefixed by `^', so `.*first' 
  means `^.*first'. Hence you can use the prefix of the hexadecimal part 
  without the `.*', e.g. `gitbug show 4444`.

  You should fix the bug:
    $ echo my great fix >> foo

  And then tell Gitbug what you did:
    $ git commit -a -m 'foo: fixed bug, FIX[.*first]'
  or
    $ git commit -a -m 'foo: fixed bug'
    $ gitbug close .*first

  That fix wasn't a fix at all, let us reopen the bug:
    $ gitbug reopen .*first

  Make a second bug:
    $ gitbug add Bug number two

  Oh, it is a duplicate of the first bug:
    $ gitbug merge .*first .*two

  Listing bugs is most useful:
    $ gitbug
    $ gitbug open
    $ gitbug closed
    $ gitbug all

  You can see your bug history in git's log:
    $ git log


License:

  X11 / MIT License
  Copyright (C) 2008  Ilmari Heikkinen <ilmari.heikkinen@gmail.com>
                      Mauricio Fernandez <mfp@acm.org>


Webpage:

  http://github.com/kig/gitbug/tree/master