Is there a way to collect all the TODO in the code in one file before push

Question

I want store all my TODOs in the code on github, but also I want collect it in one file so I can show them all in one place to my colleagues. Maybe someone solve this task already? With git hooks maybe?

Answer 1

Well, if you have some specific pattern for your TODOs you can simply grep them.

grep -R TODO . > todo.txt

The next step is to decide when you want this file to be updated. If you want this to happen before push, you'll need at least git 1.8.2, since pre-push hook was added in this release.

Answer 2

Or you can use Todofy (https://todofy.org), it lists out all the todos in the repository after integration, and keep tracking its state un till its finished (removed from code). It provides more features like adding deadline, reminders, assigning someone or bringing someone to discussion, labels etc.

Example comment with prettifiers (C++ style comment)

// TODO: something has to be done quickly @deadline: 1 week
// @assign: mebjas @priority: high

Also it has an inbuilt option to auto create issues in Github.