Это будет хаос, чтобы не отслеживать ошибки и запросы функций при разработке программного обеспечения. Наличие простого средства отслеживания проблем сделало бы управление проектом гораздо более успешным. Теперь мне нравятся простые вещи, и я думаю, что для небольшого проекта, наличие этого трекера прямо внутри системы управления версиями (особенно с DSVC, например, Mercurial / Git и т. Д.), Не только выполнимо, но и очень удобно. Вам не нужно сходить с ума от всех причудливых функций, но достаточно просто для отслеживания проблем. Я хотел бы предложить этот макет для вас.
Допустим, у вас есть проект, который выглядит так
|
1
2
3
4
|
project +- src/main/java/Hello.java +- issues/issue-001.md +- pom.xml |
Все, что мне нужно, это простые issues с каталогами, чтобы начать работу. Теперь у меня есть место для отслеживания моей проблемы! Первый выпуск вопроса- issue-000.md должен быть о чем ваш проект. Например:
|
01
02
03
04
05
06
07
08
09
10
11
12
13
14
|
/id=issue-001/createdon=2012-12-16 18:07:08/type=bug/status=new/resolution=/from=Zemian/to=/found=/fixed=/subject=A simple Java Hello program# Updated on 2012-12-16 18:07:08We want to create a Maven based Hello world program. It should print 'Hello World.' |
Я выбираю .md качестве расширения файла для написания комментариев в формате Markdown. Поскольку это текстовый файл, вы делаете то, что хотите. Чтобы быть более структурированным, я добавил несколько метаданных заголовков для отслеживания проблем. Давайте определим некоторые здесь. Я бы предложил использовать их и форматирование:
|
1
2
3
4
5
6
7
8
9
|
/id=issue-<NUM> /createdon=<TIMESTAMP> /type=feature|bug|question /status=new|reviewing|working|onhold|testing|resolved /resolution=fixed|rejected|duplicated /from=<REPORTER_FROM_NAME> /to=<ASSIGNEE_TO_NAME> /found=<VERSION_FOUND> /fixed=<VERSION_FIXED> |
Это должно охватывать большинство проблем с ошибками и разработкой функций. Это не круто писать программы без истории изменений, включая эти проблемы. Итак, давайте использовать источник контроля. Я настоятельно рекомендую вам использовать Mercurial hg . Вы можете создать и инициализировать новый репозиторий следующим образом.
|
1
2
3
4
|
bash> cd projectbash> hg initbash> hg addbash> hg commit -m 'My hello world project' |
Теперь ваш проект создан, и у нас есть место для отслеживания ваших проблем. Теперь это простой текстовый файл, поэтому используйте ваш любимый текстовый редактор и редактируйте его. Однако создание новой проблемы с этими тегами заголовка скучно. Будет неплохо иметь скрипт, который немного справится с этим. У меня есть Groovy-скрипт issue.groovy (см. В конце этой статьи), который позволяет запускать отчеты и создавать новые проблемы. Вы можете добавить этот сценарий в каталог вашего project/issues и мгновенно создавать новые отчеты о проблемах и запросах! Вот пример вывода на моем ПК:
|
01
02
03
04
05
06
07
08
09
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
|
bash> cd projectbash> groovy scripts/issue.groovySearching for issues with /status!=resolvedIssue: /id=issue-001 /status=new /subject=A simple Java Hello program1 issues found.bash> groovy scripts/issue.groovy --new /type=feature /subject='Add a unit test.'project/issues/issue-002.md created./id=issue-002/createdon=2012-12-16 19:10:00/type=feature/status=new/resolution=/from=Zemian/to=/found=/fixed=/subject=Add a unit test.bash> groovy scripts/issue.groovySearching for issues with /status!=resolvedIssue: /id=issue-000 /status=new /subject=A simple Java Hello programIssue: /id=issue-002 /status=new /subject=Add a unit test.2 issues found.bash> groovy scripts/issue.groovy --details /id=002Searching for issues with /id=002Issue: /id=issue-002 /createdon=2012-12-16 19:10:00 /found= /from=Zemian /resolution= /status=new /type=feature /subject=Add a unit test.1 issues found.bash> groovy scripts/issue.groovy --update /id=001 /status=resolved /resolution=fixed 'I fixed this thang.'Updating issue /id=issue-001Updating /status=resolvedUpdating /resolution=fixedUpdate issue-001 completed. |
Сценарий дает вам быстрый и последовательный способ создания / обновления / поиска проблем. Но это просто текстовые файлы! Вы также можете запустить ваш любимый текстовый редактор и изменить любую вещь, которую вы хотите. Сохраните и даже зафиксируйте его в вашем исходном хранилище. Все не будет потеряно.
Вот мой скрипт issue.groovy :
|
001
002
003
004
005
006
007
008
009
010
011
012
013
014
015
016
017
018
019
020
021
022
023
024
025
026
027
028
029
030
031
032
033
034
035
036
037
038
039
040
041
042
043
044
045
046
047
048
049
050
051
052
053
054
055
056
057
058
059
060
061
062
063
064
065
066
067
068
069
070
071
072
073
074
075
076
077
078
079
080
081
082
083
084
085
086
087
088
089
090
091
092
093
094
095
096
097
098
099
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
#!/usr/bin/env groovy//// A groovy script to manage issue files and its metadata/headers.//// Created by Zemian Deng <[email protected]> 12/2012 v1.0.1//// Usage:// bash> groovy [java_opts] issue.groovy [option] [/header_name=value...] [arguments]//// Examples:// # Report all issues that match headers (we support RegEx!)// bash> groovy issue /resolution=fixed// bash> groovy issue /status!=onhold// bash> groovy issue '/subject=Improve UI|service'// bash> groovy issue --details /status=resolved//// # Create a new bug issue file.// bash> groovy issue --new /type=bug /to=zemian /found=v1.0.1 /subject='I found some problem.' 'More details here.'//// # Update an issue// bash> groovy issue --update /id=issue-001 /status=resolved /resolution=fixed 'I fixed this issue with Z algorithm.'//// Becareful on the following notes:// * Ensure your filename issue id match to the /id or your search may not work!// * You need to use quote the entire header such as these 'key=space value'//class issue { def ISSUES_HEADERS = ['/id', '/createdon', '/type', '/status', '/resolution', '/from', '/to', '/found', '/fixed', '/subject'] def ISSUES_HEADERS_VALS = [ '/type' : ['feature', 'bug', 'question'] as Set, '/status' : ['new', 'reviewing', 'working', 'onhold', 'testing', 'resolved'] as Set, '/resolution' : ['fixed', 'rejected', 'duplicated'] as Set ] def issuesDir = new File(System.getProperty("issuesDir", getDefaultIssuesDir())) def issuePrefix = System.getProperty("issuePrefix", 'issue') def arguments = [] // script arguments after parsing def options = [:] // script options after parsing def headers = [:] // user input issue headers static void main(String[] args) { new issue().run(args) } // Method declarations def run(String[] args) { // Parse and save options, arguments and headers vars args.each { arg -> def append = true if (arg =~ /^--{0,1}\w+/) { options[arg] = true append = false } else { def pos = arg.indexOf('=') if (pos >= 1 && arg.length() > pos) { def name = arg.substring(0, pos) def value = arg.substring(pos + 1) headers.put(name, value) append = false } } if (append) { arguments << arg } } // support short option flag if (options['-d']) options['--details'] = true // Run script depending on options passed if (options['--help'] || options['-h']) { printHelp() } else if (options['--new'] || options['-n']) { createIssue() } else if (options['--update'] || options['-u']) { updateIssue() } else { reportIssues() } } def printHelp() { new File(getClass().protectionDomain.codeSource.location.path).withReader{ reader -> def done = false def line = null while (!done && (line = reader.readLine()) != null) { line = line.trim() if (line.startsWith("#") || line.startsWith("//")) println(line) else done = true } } } def validateHeaders() { def headersSet = ISSUES_HEADERS.toSet() headers.each{ name, value -> if (!headersSet.contains(name)) throw new Exception("ERROR: Unkown header name $name.") if (ISSUES_HEADERS_VALS[name] != null && !(ISSUES_HEADERS_VALS[name].contains(value))) throw new Exception("ERROR: Unkown header $name=$value. Allowed: ${ISSUES_HEADERS_VALS[name].join(', ')}") } } def getDefaultIssuesDir() { return new File(getClass().protectionDomain.codeSource.location.path).parentFile.path } def getIssueIds() { def issueIds = [] def files = issuesDir.listFiles() if (files == null) return issueIds files.each{ f -> def m = f.name =~ /^(\w+-\d+)\.md$/ if (m) issueIds << m[0][1] } return issueIds } def getIssueFile(String issueid) { return new File(issuesDir, "${issueid}.md") } def reportIssues() { def userHeaders = new HashMap(headers) if (userHeaders.size() ==0) userHeaders['/status!'] = 'resolved' def headersLine = userHeaders.sort{ a,b -> a.key <=> b.key }.collect{ k,v -> "$k=$v" }.join(', ') println "Searching for issues with $headersLine" def count = 0 getIssueIds().each { issueid -> def file = getIssueFile(issueid) def issueHeaders = [:] file.withReader{ reader -> def done = false def line = null while (!done && (line = reader.readLine()) != null) { if (line =~ /^\/\w+=.*$/) { def words = line.split('=') if (words.length >= 2) { issueHeaders.put(words[0], words[1..-1].join('=')) } } else if (issueHeaders.size() > 0) { done = true } } } def match = userHeaders.findAll{ k,v -> if (k.endsWith("!")) (issueHeaders[k.substring(0, k.length() - 1)] =~ /${v}/) ? false : true else (issueHeaders[k] =~ /${v}/) ? true : false } if (match.size() == userHeaders.size()) { def line = "Issue: /id=${issueHeaders['/id']}" if (options['--details']) { def col = 4 def issueHeadersKeys = issueHeaders.keySet().sort() - ['/id', '/subject'] issueHeadersKeys.collate(col).each { set -> line += "\n " + set.collect{ k -> "$k=${issueHeaders[k]}" }.join(" ") } line += "\n /subject=${issueHeaders['/subject']}" } else { line += " /status=${issueHeaders['/status']}" + " /subject=${issueHeaders['/subject']}" } println line count += 1 } } println "$count issues found." } def createIssue() { validateHeaders() if (headers['/status'] == 'resolved' && headers['/resolution'] == null) throw new Exception("You must provide /resolution after resolved an issue.") def ids = getIssueIds().collect{ issueid -> issueid.split('-')[1].toInteger() } def nextid = ids.size() > 0 ? ids.max() + 1 : 1 def issueid = String.format("${issuePrefix}-%03d", nextid) def file = getIssueFile(issueid) def createdon = new Date().format('yyyy-MM-dd HH:mm:ss') def newHeaders = [ '/id' : issueid, '/createdon' : createdon, '/type' : 'bug', '/status' : 'new', '/resolution' : '', '/from' : System.properties['user.name'], '/to' : '', '/found' : '', '/fixed' : '', '/subject' : 'A bug report' ] // Override newHeaders from user inputs headers.each { k,v -> newHeaders.put(k, v) } //Output to file file.withWriter{ writer -> ISSUES_HEADERS.each{ k -> writer.println("$k=${newHeaders[k]}") } writer.println() writer.println("# Updated on ${createdon}") writer.println() arguments.each { writer.println(it) writer.println() } writer.println() } // Output issue headers to STDOUT println "$file created." ISSUES_HEADERS.each{ k -> println("$k=${newHeaders[k]}") } } def updateIssue() { validateHeaders() if (headers['/status'] == 'resolved' && headers['/resolution'] == null) throw new Exception("You must provide /resolution after resolved an issue.") def userHeaders = new HashMap(headers) userHeaders.remove('/createdon') // we should not update this field def issueid = userHeaders.remove('/id') // We will not re-update /id if (issueid == null) throw new Exception("Failed to update issue: missing /id value.") if (!issueid.startsWith(issuePrefix)) issueid = "${issuePrefix}-${issueid}" println("Updating issue /id=${issueid}") def file = getIssueFile(issueid) def newFile = new File(file.parentFile, "${file.name}.update.tmp") def hasUpdate = false def issueHeaders = [:] if (!file.exists()) throw new Exception("Failed to update issue: file not found for /id=${issueid}") // Read and update issue headers file.withReader{ reader -> // Read all issue headers first def done = false def line = null while (!done && (line = reader.readLine()) != null) { if (line =~ /^\/\w+=.*$/) { def words = line.split('=') if (words.length >= 2) { issueHeaders.put(words[0], words[1..-1].join('=')) } } else if (issueHeaders.size() > 0) { done = true } } // Find issue headers differences userHeaders.each{ k,v -> if (issueHeaders[k] != v) { println("Updating $k=$v") issueHeaders[k] = v if (!hasUpdate) hasUpdate = true } } // Update issue file if (hasUpdate) { newFile.withWriter{ writer -> ISSUES_HEADERS.each{ k -> writer.println("${k}=${issueHeaders[k] ?: ''}") } writer.println() // Write/copy the rest of the file. done = false while (!done && (line = reader.readLine()) != null) { writer.println(line) } writer.println() } } } // reader if (hasUpdate) { // Rename the new file back to orig file.delete() newFile.renameTo(file) } // Append any arguments as user comments if (arguments.size() > 0) { file.withWriterAppend{ writer -> writer.println() writer.println("# Updated on ${new Date().format('yyyy-MM-dd HH:mm:ss')}") writer.println() arguments.each{ text -> writer.println(text) writer.println() } println() } } println("Update $issueid completed.") }} |
Ссылка: Простой трекер проблем Groovy, использующий файловую систему от нашего партнера по JCG Земьяна Дена в блоге журнала A Programmer’s Journal .