https://github.com/augmentable-dev/tickgit
Manage your repository's TODOs, tickets and checklists as config in your codebase.
https://github.com/augmentable-dev/tickgit
git golang tickets tickgit todo todos
Last synced: 17 days ago
JSON representation
Manage your repository's TODOs, tickets and checklists as config in your codebase.
- Host: GitHub
- URL: https://github.com/augmentable-dev/tickgit
- Owner: augmentable-dev
- License: mit
- Created: 2019-10-12T00:49:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-18T21:48:47.000Z (over 1 year ago)
- Last Synced: 2024-11-05T10:44:48.682Z (6 months ago)
- Topics: git, golang, tickets, tickgit, todo, todos
- Language: Go
- Homepage:
- Size: 3.91 MB
- Stars: 324
- Watchers: 8
- Forks: 19
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go-extra - tickgit - 10-12T00:49:10Z|2022-01-15T20:46:13Z| (Code Analysis / Routers)
README
[](https://godoc.org/github.com/augmentable-dev/tickgit)
[](https://github.com/augmentable-dev/tickgit/actions?workflow=tests)
[](https://goreportcard.com/report/github.com/augmentable-dev/tickgit)
[](http://gocover.io/github.com/augmentable-dev/tickgit)
[](https://www.tickgit.com/browse?repo=github.com/augmentable-dev/tickgit)
## tickgit 🎟️
`tickgit` is a tool to help you manage latent work in a codebase. Use the `tickgit` command to view pending tasks, progress reports, completion summaries and historical data (using `git` history).
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.
### TODOs
`tickgit` will scan a codebase and identify any TODO items in the comments. It will output a report like so:
```
# tickgit ~/Desktop/facebook/react
...
TODO:
=> packages/scheduler/src/__tests__/SchedulerBrowser-test.js:85:9
=> added 1 month ago by Andrew Clark in a2e05b6c148b25590884e8911d4d4acfcb76a487
TODO: Scheduler no longer requires these methods to be polyfilled. But
=> packages/scheduler/src/__tests__/SchedulerBrowser-test.js:77:7
=> added 1 month ago by Andrew Clark in a2e05b6c148b25590884e8911d4d4acfcb76a487
TODO: Scheduler no longer requires these methods to be polyfilled. But
=> packages/scheduler/src/forks/SchedulerHostConfig.default.js:77:7
=> added 1 month ago by Andrew Clark in a2e05b6c148b25590884e8911d4d4acfcb76a487
TODO: useTransition hook instead.
=> fixtures/concurrent/time-slicing/src/index.js:110:11
=> added 3 weeks ago by Sebastian Markbåge in 3ad076472ce9108b9b8a6a6fe039244b74a34392
128 TODOs Found 📝
```
Check out [an example](https://www.tickgit.com/browse?repo=github.com/kubernetes/kubernetes) of the TODOs tickgit will surface for the Kubernetes codebase.
#### Coming Soon
- [x] Blame - get a better sense of how old TODOs are, when they were introduced and by whom
- [ ] Context - more visibility into the lines of code _around_ a TODO for greater context
- [ ] More `TODO` type phrases to match, such as `FIXME`, `XXX`, `HACK`, or customized alternatives.
- [ ] More configurability (e.g. custom ignore paths)
- [ ] Markdown parsing
- [ ] More thorough historical stats
### Installation
#### Homebrew
```
brew tap augmentable-dev/tickgit
brew install tickgit
```
### Usage
The most up to date usage will be the output of `tickgit --help`.
### API
To find information about using the tickgit API, see [this file](https://github.com/augmentable-dev/tickgit/blob/master/docs/API.md).