1 # Experimental Tag Sharing / Pseudo-Bug-Tracking for/with notmuch
5 There is a dump of (some views of) the nmbug [[status|http://nmbug.tethera.net/status]].
9 1. Install and use notmuch version notmuch 0.9+63~gebd1adc or newer.
11 The nmbug script is available in `contrib/nmbug`.
13 2. The current tag repo can be obtained by:
15 `$ git clone --bare http://nmbug.tethera.net/git/nmbug-tags.git $HOME/.nmbug`
17 Check that your git is recent enough by entering:
19 `$ git --git-dir=$HOME/.nmbug fetch`
21 If you get failures then you need to update your git (as well).
23 ## Using nmbug, simple example
25 # get the latest version of the tags
28 # do some tagging; see below for conventions
29 $ notmuch tag +notmuch::patch $id
31 # write the tag changes from the notmuch database
34 ## Using nmbug, doing the same thing with more steps
36 # get the latest version of the tags
39 # Optionally inspect the fetched changes
45 # merge the fetched tags into notmuch
48 # observe status is clear now,
51 # make the tag changes
52 $ notmuch tag +notmuch::patch id
54 # double check your changes
58 # write the tag changes
63 For the moment, we are using a central repo, hosted at:
65 nmbug@nmbug.tethera.net:nmbug-tags
67 To get push access, send your public key (ideally in a gpg signed
68 email) to David Bremner. There is a convenience command:
72 But you will have to change your url with:
74 $ git --git-dir=$HOME/.nmbug remote set-url origin nmbug@nmbug.tethera.net:nmbug-tags
76 ## Tagging conventions
78 _Note that the tag database is probably catching up to these
81 ### Main patch tracking tags
83 Initially any patch should be tagged:
87 Patches that are for discussion, rather than proposed for master should be tagged:
89 notmuch::wip is "work in progress", posted for review or comment.
91 Most patches will be initially tagged:
93 notmuch::needs-review needs some (more) review
95 unless they are tagged:
97 notmuch::trivial looks harmless
99 Patches keep `notmuch::needs-review` until they either get enough
100 reviews, or one of the following resolutions is reached:
102 notmuch::obsolete replaced by some other patch
103 notmuch::pushed is pushed to master
104 notmuch::wontfix for whatever reason, this patch will not
107 Sometimes the process stalls, and patches get tagged:
109 notmuch::moreinfo waiting for feedback from patch proposer
114 So far we are just tagging certain messages as bug reports, meaning
115 things that "everyone" agrees should be fixed.
117 notmuch::bug is a bug report
121 These patches are more comments and suggestions.
123 notmuch::emacs is a patch/bug for the emacs UI
124 notmuch::feature provides a new feature
125 notmuch::fix fixes a bug
126 notmuch::portability improves portability
127 notmuch::review is a review
128 notmuch::test provides a new test/or improves testing
129 notmuch::$n this patch should be considered for
132 ## Tracking the patch queue
134 I (David Bremner) use the following search (in my case as a saved
137 tag:notmuch::patch and not tag:notmuch::pushed and \
138 not tag:notmuch::obsolete and not tag:notmuch::wip \
139 and not tag:notmuch::moreinfo and not tag:notmuch::contrib
141 You might or might not want as many exclusions. Another interesting
144 tag:notmuch::reviewed and not tag:notmuch::pushed
150 The tags are stored in a bare-repo, which means they are not obviously
151 visible. There is an `nmbug archive` command analogous to `git
152 archive` Tags are represented as empty files in the tree; if you extra
153 them, the tree looks something like:
155 tags/878waiwi0f.wl%25james@hackervisions.org/
156 tags/878waiwi0f.wl%25james@hackervisions.org/emacs
157 tags/878waiwi0f.wl%25james@hackervisions.org/patch
158 tags/87aa8j7hqu.fsf@zancas.localnet/
159 tags/87aa8j7hqu.fsf@zancas.localnet/patch
160 tags/87aa8j7hqu.fsf@zancas.localnet/pushed
162 The `%25` represents hex code for a character that cannot be used directly
163 (in this case %, only because it is needed as an escape).
167 - Currently the parser of nmbug (like that of notmuch restore) assumes
168 that there are no spaces in message-ids.