Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.86 KB

README.md

File metadata and controls

40 lines (32 loc) · 1.86 KB
Raw

Gitdo - Track TODO comments in your task manager.

AppLogo

Introduction

Gitdo is a tool for formalising the tracking of task annotations in source code. The idea is that when a new git (working on mercurial support as well) commit contains a new task such as;

// TODO: Make sure the README makes sense in explaining this.

Gitdo will capture it at pre-commit time, use the chosen plugin (see here) to get an ID for which will be added to the source code. Then when a git push is ran it will add the new tasks to the chosen task manager.

Example video

See example

See Wiki for documentation

Task Annotations

Example Captured
//TODO: Is this captured? Y
// TODO: Is this captured? Y
// TODO Is this captured? N
# TODO: Is this captured? Y
#TODO: Is this captured? Y
# TODO Is this captured? N
//TODO(): Is this captured Y

Test your own string

Using experimental vgo tool for dependencies.

install: go get -u golang.org/x/vgo See research by Russ Cox here

Known Issues

  1. If a commit message is empty, gitdo will run, even though git will fail.
  2. If a task has a new line character it will not look at the second line, and treat only the first line.
  3. If a plugin fails, it is not clear whether gitdo will fail to, and stop the commit.
  4. Cannot get it to run when committing from Eclipse. Running Git from CLI is best How to fix.
  5. Intellij runs hook if selected, but will not give information unless it fails. Running Git from CLI is best.