-
Notifications
You must be signed in to change notification settings - Fork 7
/
HOWTO_DITZ
61 lines (42 loc) · 2.03 KB
/
HOWTO_DITZ
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
==========
Ditz HOWTO
==========
What?
=====
(from the ditz README) http://ditz.rubyforge.org
Ditz is a simple, light-weight distributed issue tracker designed to work with
distributed version control systems like git.
Ditz maintains an issue database directory on disk, with files written in a
line-based and human-editable format. This directory is kept under version
control, alongside project code.
Ditz provides a simple, console-based interface for creating and updating the
issue database files, and some basic static HTML generation capabilities for
producing world-readable status pages.
Why?
====
We have had a long standing need for documenting bugs, features etc. With Ditz
and git we can have a full track record of bug fixes, issue tracking and so on.
Ditz is very simple to use and has basic features, full blown issue trackers
take up a lot of time.
How?
====
We don't need much functionality, so here is a subset of what is required
on a daily basis:
* ``ditz add`` Add an *issue*, *bug-fix* or *feature*.
* ``ditz status`` Show assigned/unassigned issues, bugs, features.
* ``ditz close`` Close a previously added issue.
* ``ditz log`` Show full logs of all issues, bugs, features.
And that is basically it. There are more functions, use ``ditz help`` to
view them.
Ditz has a concept of releases, which are different versions of the system.
A ticket (bug-fix/feature/issue) is assigned to a release. We have just one
release that we are working on, Beryllium.
Ditz creates and stores the ticket files in the .ditz directory. So, git has
to be updated after any changes have been done with Ditz. There is a script
in the top level Speect directory, ``git-ditz.sh``, which will do this for
you. It adds any Ditz changes to the git staging area, commits these to
your repository and then pushes up to dudley (if dudley is reachable).
**IMPORTANT**
If you are not going to use the ``git-ditz.sh`` script, you must please
commit Ditz changes separately from other changes, and use "ditz update"
as your commit message.