You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-47Lines changed: 2 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
8
8
## tickgit 🎟️
9
9
10
-
`tickgit` is a tool to help you manage tickets, todo items, and checklists within a codebase. Use the `tickgit` command to view pending tasks, progress reports, completion summaries and historical data (using `git` history).
10
+
`tickgit` is a tool to help you manage tickets, todo items, and checklists in a codebase. Use the `tickgit` command to view pending tasks, progress reports, completion summaries and historical data (using `git` history).
11
11
12
12
It's not meant to replace full-fledged project management tools such as JIRA or Trello. It will, hopefully, be a useful way to augment those tools with project management patterns that coexist with your code. As such, it's primary audience is software engineers.
13
13
@@ -44,50 +44,6 @@ Check out [an example](https://todos.tickg.it/?repo=https://github.com/kubernete
44
44
-[x] History - get a better sense of how old TODOs are, when they were introduced and by whom
45
45
-[ ] Context - more visibility into the lines of code _around_ a TODO for greater context
46
46
47
-
### Tickets
48
-
49
-
Tickets are a way of defining more complex tasks in your codebase as config files. Currently, tickets are HCL files that look like the following:
50
-
51
-
```hcl
52
-
# rocketship.tickgit
53
-
54
-
goal "Build the Rocketship 🚀" {
55
-
description = "Finalize the construction of the Moonblaster 2000"
56
-
57
-
task "Construct the engines" {
58
-
status = "done"
59
-
}
60
-
61
-
task "Attach the engines" {
62
-
status = "pending"
63
-
}
64
-
65
-
task "Thoroughly test the engines" {
66
-
status = "pending"
67
-
}
68
-
}
69
-
```
70
-
71
-
```
72
-
$ tickgit status
73
-
=== Build the Rocketship 🚀 ⏳
74
-
--- 1/3 tasks completed (2 remaining)
75
-
--- 33% completed
76
-
77
-
✅ Construct the engines
78
-
⏳ Attach the engines
79
-
⏳ Thoroughly test the engines
80
-
```
81
-
82
-
#### Coming Soon
83
-
84
-
-[ ] Simpler ticket definitions - in YAML and/or other (less verbose) config languages
85
-
-[ ] More complex tickets - more states, dependencies on other tickets, etc
86
-
87
-
### Checklists
88
-
89
-
_Coming soon_. Checklists will be a way of parsing Markdown checklists in your codebase (either in `.md` files, or within your comments).
90
-
91
47
92
48
### Why is this useful?
93
49
@@ -110,10 +66,9 @@ brew tap augmentable-dev/tickgit
110
66
brew install tickgit
111
67
```
112
68
113
-
114
69
### Usage
115
70
116
-
The most up to date usage will be the output of `tickgit --help`. The most common usage, however, is `tickgit status` which will print a status report of tickets for a given git repository. By default, it uses the current working directory.
71
+
The most up to date usage will be the output of `tickgit --help`.
0 commit comments