DEV Community

Patrick DeVivo
Patrick DeVivo

Posted on • Updated on

Managing tickets and todos within your codebase - does it make sense? Looking for feedback

Hey everyone - I've begun working on a side project called tickgit, which I'm hoping is something that could be useful for anyone writing code and using a git repo (presumably many folks here!)

I would love any feedback, and am looking for ways to make this tool useful. It's fairly rudimentary in its current state: augmentable-dev/tickgit but I have high hopes for making it a great developer experience for managing tickets, todos, checklists (and whatever other project-manage-y type things) might exist in a codebase or git repo.

Please share your thoughts! The README has much more detail, and you can run a basic version of it today (installable via homebrew).

the tldr for how it works currently:

$ tickgit todos ~/Desktop/facebook/react
...
TODO: does clang define __GNUC__ ?
  => /Users/.../Desktop/facebook/react/scripts/perf-counters/src/portability.h:34:3

TODO: FIXME! Without this implemented properly, the JIT
  => /Users/.../Desktop/facebook/react/scripts/perf-counters/src/portability.h:133:3

TODO: it's awkward to create a bundle for this but if we don't, the package
  => /Users/.../Desktop/facebook/react/scripts/rollup/bundles.js:454:7

TODO: this is too permissive.
  => /Users/.../Desktop/facebook/react/scripts/rollup/validate/eslintrc.umd.js:20:7

TODO: type it.
  => /Users/.../Desktop/facebook/react/scripts/shared/inlinedHostConfigs.js:25:27

123 TODOs Found 📝

for getting a snapshot and pointers to TODOs.

# rocketship.tickgit

goal "Build the Rocketship 🚀" {
    description = "Finalize the construction of the Moonblaster 2000"

    task "Construct the engines" {
        status = "done"
    }

    task "Attach the engines" {
        status = "pending"
    }

    task "Thoroughly test the engines" {
        status = "pending"
    }
}

and

$ tickgit status
=== Build the Rocketship 🚀 ⏳
  --- 1/3 tasks completed (2 remaining)
  --- 33% completed

  ✅ Construct the engines
  ⏳ Attach the engines
  ⏳ Thoroughly test the engines

as an example of defining and managing simple tickets in your codebase

Top comments (0)