kig / gitbug

In-repo bug tracker for Git

gitbug / README
raw normal view history
848c11c9 » kig 2008-09-17 README 1 Gitbug is an in-repo bug tracker for Git repositories.
2
0fb9300a » kig 2008-09-17 license 3
848c11c9 » kig 2008-09-17 README 4 Installation:
5
dfbd0787 » kig 2008-09-17 README: installing dependen... 6 0. Install ocamlfind, omake and the OCaml libraries pcre and netstring.
7 On a Debian/Ubuntu:
2211e82e » Ilmari Heikkinen 2008-09-21 README: -dev versions of libs 8 $ sudo apt-get install libocamlnet-ocaml-dev libpcre-ocaml-dev omake ocaml-findlib
dfbd0787 » kig 2008-09-17 README: installing dependen... 9
848c11c9 » kig 2008-09-17 README 10 1. Compile
11 $ omake
12
13 2. Copy the executable to somewhere in your path
14 $ cp gitbug.opt ~/bin/gitbug
15
16 Usage:
17
f32317da » kig 2008-09-17 README: mention gitbug help 18 List of commands:
19 $ gitbug help
20
848c11c9 » kig 2008-09-17 README 21 You need a Git repository:
22 $ mkdir my_git_repo
23 $ cd my_git_repo
24 $ git init
ab6839bc » kig 2008-09-17 expanded foo example in README 25 $ echo buggy foo > foo
26 $ git add foo
27 $ git commit -m 'buggy foo'
848c11c9 » kig 2008-09-17 README 28
29 Then you should initialize the bug tracker:
30 $ gitbug init
31
32 And add a bug:
33 $ gitbug add This is my first bug
34
35 Maybe look at it and edit it:
36 $ gitbug
45bf4d78 » kig 2009-02-16 fixed use_autoclose when mi... 37 -- Open bugs
38 444468c69994_This_is_my_first_bug 2009-02-16 15:39:18+0200
39
40 $ gitbug show .*first
b842c537 » kig 2009-02-16 fix to bug listing, readme ... 41 $ gitbug edit .*first
848c11c9 » kig 2008-09-17 README 42
45bf4d78 » kig 2009-02-16 fixed use_autoclose when mi... 43 Gitbug treats the pattern as a regexp prefixed by `^', so `.*first'
44 means `^.*first'. Hence you can use the prefix of the hexadecimal part
45 without the `.*', e.g. `gitbug show 4444`.
46
47 You should fix the bug:
848c11c9 » kig 2008-09-17 README 48 $ echo my great fix >> foo
49
50 And then tell Gitbug what you did:
45bf4d78 » kig 2009-02-16 fixed use_autoclose when mi... 51 $ git commit -a -m 'foo: fixed bug, FIX[.*first]'
52 or
848c11c9 » kig 2008-09-17 README 53 $ git commit -a -m 'foo: fixed bug'
b842c537 » kig 2009-02-16 fix to bug listing, readme ... 54 $ gitbug close .*first
848c11c9 » kig 2008-09-17 README 55
56 That fix wasn't a fix at all, let us reopen the bug:
b842c537 » kig 2009-02-16 fix to bug listing, readme ... 57 $ gitbug reopen .*first
848c11c9 » kig 2008-09-17 README 58
7b3e3161 » kig 2008-09-17 mention the merge command 59 Make a second bug:
60 $ gitbug add Bug number two
61
62 Oh, it is a duplicate of the first bug:
b842c537 » kig 2009-02-16 fix to bug listing, readme ... 63 $ gitbug merge .*first .*two
7b3e3161 » kig 2008-09-17 mention the merge command 64
848c11c9 » kig 2008-09-17 README 65 Listing bugs is most useful:
66 $ gitbug
67 $ gitbug open
68 $ gitbug closed
69 $ gitbug all
70
71 You can see your bug history in git's log:
72 $ git log
73
a689b950 » kig 2008-09-17 webpage info 74
0fb9300a » kig 2008-09-17 license 75 License:
76
77 X11 / MIT License
a689b950 » kig 2008-09-17 webpage info 78 Copyright (C) 2008 Ilmari Heikkinen <ilmari.heikkinen@gmail.com>
79 Mauricio Fernandez <mfp@acm.org>
80
81
82 Webpage:
83
84 http://github.com/kig/gitbug/tree/master
85