Skip to content

Commit 087b89e

Browse files
committed
fix some typos, reword a bit
1 parent c9b665c commit 087b89e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
`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).
1010

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.
1212

1313
### TODOs
1414

@@ -37,8 +37,8 @@ TODO: type it.
3737

3838
#### Coming Soon
3939

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
4242

4343
### Tickets
4444

@@ -77,12 +77,12 @@ $ tickgit status
7777

7878
#### Coming Soon
7979

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
8282

8383
### Checklists
8484

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).
8686

8787

8888
### 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
9595
- Current status of a `goal` can be reported by simply parsing the repository's `head`
9696
- Less context switching between the codebase itself and the system describing "what needs to be done"
9797

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.
9999

100100
### Installation
101101

0 commit comments

Comments
 (0)