39
39
https://launchpad.net/~jkakar/+archive/commandant
45
Kanban has some explicit design goals:
47
* High-level overview: we want a kanban-esque view of a milestone, a
48
way to easily see how things are going, at a glance.
50
* Zero intervention: other than creating bugs and branches and using
51
the tools in Launchpad to represent manage state as part of the
52
normal development process, no additional effort should be
53
required to maintain a kanban board.
55
* Uncomplicated: the board must useful, but as simple as possible,
56
so that it isn't overwhelming to look at.
62
Kanban has a simple frontend to authenticate with Launchpad and
63
generate an HTML file representing the bugs in a particular milestone
64
for a project or project group in Launchpad.
66
Authenticating with Launchpad
67
-----------------------------
69
Before you can generate a kanban board you need to authenticate with
72
$ bin/kanban launchpad-login
74
This will create OAuth credentials in $HOME/.config/kanban. In
75
addition, Kanban will cache data in $HOME/.cache/kanban.
77
Generating a kanban board
78
-------------------------
80
Once you've authenticated Kanban with Launchpad you're ready to
81
generate an HTML kanban board for your project.
83
You can generate various different Kanban views, depending on how your project
86
To see the bugs targetted to a to the 0.19 milestone of storm::
88
$ bin/kanban generate-html storm 0.19 > kanban.html
90
To see all bugs assigned to a particular person, including bugs 'Fix
91
released' in the last month::
93
$ bin/kanban generate-person-kanban mbp > kanban.html
98
The kanban board assumes a set of bug categories: queued, in progress,
99
needs review, needs testing, verified and released. These categories
100
represent best practice for using Launchpad and are hard-coded to keep
101
things simple. With the exception of the verified category, they can
102
each be determined from Launchpad state alone. When a bug has been
103
tested and confirmed to work, it will be put in the verified category
104
if it has the 'verified' tag.
109
A high-level overview of a milestone is useful, but bugs are not
110
isolated from each other. In many cases, a small collection of bugs
111
represent the changes needed to realize a complete feature. Bugs with
112
'story-<name>' tags are grouped into lanes, to show the progress of
113
related bugs. Using these tags is optional.
45
Run the following command to learn how to use Kanban in more detail:
47
$ bin/kanban help tutorial | less
added
removed
README
