public
Description: In-repo bug tracker for Git
Homepage:
Clone URL: git://github.com/kig/gitbug.git
commit  45bf4d789470344a9e70e317ffdee9ae5a04d21d
tree    c36e658b0cd3416a6382db0a5c99c4e0e8fd764d
parent  eec5797699b0fe42d30db8b4e606249d7f7f035d
gitbug / README
100644 86 lines (58 sloc) 1.887 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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