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
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
9
9
`tickgit` is an experiment in code-based project management. It's 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
10
11
-
It's certainly not meant to replace project management tools such as JIRA, Trello, etc. 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.
11
+
It's certainly not meant to replace project management tools such as JIRA, Trello, etc. 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.
12
12
13
13
### TODOs
14
14
@@ -37,8 +37,8 @@ TODO: type it.
37
37
38
38
#### Coming Soon
39
39
40
-
-[ ]TODO history - get a better send of how old TODOs are, when they were introduced and by whom
41
-
-[ ]TODO context - more visibility into the lines of code _around_ a TODO for greater context
40
+
-[ ]History - get a better sense of how old TODOs are, when they were introduced and by whom
41
+
-[ ]Context - more visibility into the lines of code _around_ a TODO for greater context
42
42
43
43
### Tickets
44
44
@@ -77,12 +77,12 @@ $ tickgit status
77
77
78
78
#### Coming Soon
79
79
80
-
-[ ] Simpler ticket definitions - perhaps in YAML or other config languages
81
-
-[ ]Support for more complex tickets - more states, support dependencies on other tickets, etc
80
+
-[ ] Simpler ticket definitions - in YAML and/or other (less verbose) config languages
81
+
-[ ]More complex tickets - more states, dependencies on other tickets, etc
82
82
83
83
### Checklists
84
84
85
-
_Coming soon_. Checklists will be a way of parsing any Markdown checklists in your code base (either in `.md` files, or within your comments).
85
+
_Coming soon_. Checklists will be a way of parsing Markdown checklists in your codebase (either in `.md` files, or within your comments).
86
86
87
87
88
88
### Why is this useful?
@@ -95,7 +95,7 @@ To be honest, I'm trying to figure that out. This project is a POC. Keeping tick
95
95
- Current status of a `goal` can be reported by simply parsing the repository's `head`
96
96
- Less context switching between the codebase itself and the system describing "what needs to be done"
97
97
98
-
Generally speaking, this is an experiment in ways to do project management, within the codebase of a project itself. With a `git` history and some clever parsing, quite a bit of metadata about a project can be gleaned from its codebase. Let's see how useful we can make that information.
98
+
Generally speaking, this is an experiment in ways to do project management, within the codebase of a project. With a `git` history and some clever parsing, quite a bit of metadata about a project can be gleaned from its codebase. Let's see how useful we can make that information.
0 commit comments