Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Github-Todos – Git hook to convert your TODOs into Github issues

github.com

Post reply on HN
Print view View original

11–20 of 20 posts

Re: Github-Todos – Git hook to convert your TODOs into Github issues

#11

Post by kartikkumar »

naholyr wrote: post #6
kartikkumar wrote: post #5

Excellent! At the moment, I dump all my TODOs in a section in my readme, but if the relate to specific lines of code, it's a mess trying to trace what the TODOs were referencing when I try to go back and work on them many months later. Once question, once a TODO is removed from the repository, is the issue also automatically closed? Or vice-versa? Would be cool if the two were coupled, so that there aren't dangling T…

This coupling is not ready yet, I still have to find a satisfying workflow. When issue is closed : — it detects TODOs anywhere, not necessarily in comments, it could destroy some code (same for 'inject-issue' but here it would be a removal, can be tougher) — maybe a TODO previously related to this issue will have to be modified instead of deleted, how should it handle it? When TODO is removed : — should I close issue…

Actually, thinking about it a bit more, I think it'd be nice to be in full control of the process. So perhaps something a la "brew doctor" would be nice, so that you simply obtain an overview of disconnected TODOs and issues. That way, it's clear that there's something lingering that needs to be taken care of.

I think that any automation should affect issues and not involve directly changing code. So, it might be interesting to have a toggle to automatically close issues after scanning the repo for the presence of TODOs. I do think that this should be a toggle that can be switched on or off.

Re: Github-Todos – Git hook to convert your TODOs into Github issues

#12

Post by naholyr »

kartikkumar wrote: post #11
naholyr wrote: post #6

Earlier quoted context omitted.

This coupling is not ready yet, I still have to find a satisfying workflow. When issue is closed : — it detects TODOs anywhere, not necessarily in comments, it could destroy some code (same for 'inject-issue' but here it would be a removal, can be tougher) — maybe a TODO previously related to this issue will have to be modified instead of deleted, how should it handle it? When TODO is removed : — should I close issue…

Actually, thinking about it a bit more, I think it'd be nice to be in full control of the process. So perhaps something a la "brew doctor" would be nice, so that you simply obtain an overview of disconnected TODOs and issues. That way, it's clear that there's something lingering that needs to be taken care of. I think that any automation should affect issues and not involve directly changing code. So, it might be int…

That's more the direction I think about yes

Re: Github-Todos – Git hook to convert your TODOs into Github issues

#15

Post by naholyr »

drinchev wrote: post #14

That rocks so much. It will fit perfectly to my workflow, where I write my commit messages with "Closes #[ID]." text at the end, which actually triggers github to automatically close the issue. Totally awesome!

Hope it will do the job :) still in active development so… https://github.com/naholyr/github-todos/issues ;)

Re: Github-Todos – Git hook to convert your TODOs into Github issues

#16

Post by naholyr »

Dewie wrote: post #13

Anyone like this better than a command line issue/bug tracker?

It's all about not forgetting to create the issue: you just put your // TODO and not go out of your editor.

An IDE plugin could do the trick nicely too (create an issue by right-clicking on a TODO for example). But a git hook is more portable.

In fact the first prototype was a shell script using grep and ghi (https://github.com/stephencelis/ghi).

Anyway, it depends on your workflow, if you already have the right tools and habits no to lose your TODOs in your deep code, Github-Todos is obviously of no use for you!

Re: Github-Todos – Git hook to convert your TODOs into Github issues

#17

Post by Dewie »

naholyr wrote: post #16
Dewie wrote: post #13

Anyone like this better than a command line issue/bug tracker?

It's all about not forgetting to create the issue: you just put your // TODO and not go out of your editor. An IDE plugin could do the trick nicely too (create an issue by right-clicking on a TODO for example). But a git hook is more portable. In fact the first prototype was a shell script using grep and ghi ( https://github.com/stephencelis/ghi ). Anyway, it depends on your workflow, if you already have the right to…

> But a git hook is more portable.

Are GitHub issues portable?

Re: Github-Todos – Git hook to convert your TODOs into Github issues

#18

Post by chadscira »

naholyr wrote: post #4
vuldin wrote: post #3

If this works as advertised, this is awesome. I've always used TODOs in my projects, and haven't always used github due to employer constraints. Now I won't have to put so much effort into keeping track of open tasks.

Hi I'm the author :) Note that it can open or comment issues (matching based on TODO's text == issue's title), but it does not yet closes them, because I couldn't find a satisfying workflow yet (which means it may never occur). Give it a try on a sample repository, always needing more testers !

Thanks for making this! I have been requesting this for over a year now and haven't had the time to do it myself. This will totally change the way issues are handled.

Re: Github-Todos – Git hook to convert your TODOs into Github issues

#19

Post by naholyr »

Dewie wrote: post #17
naholyr wrote: post #16

Earlier quoted context omitted.

It's all about not forgetting to create the issue: you just put your // TODO and not go out of your editor. An IDE plugin could do the trick nicely too (create an issue by right-clicking on a TODO for example). But a git hook is more portable. In fact the first prototype was a shell script using grep and ghi ( https://github.com/stephencelis/ghi ). Anyway, it depends on your workflow, if you already have the right to…

> But a git hook is more portable. Are GitHub issues portable?

Ah ah nope, and that arised fast (issue #4) ;)

But definitely, if you find it useless, then it certainly is for you! I was just telling why others could find it useful :)

Re: Github-Todos – Git hook to convert your TODOs into Github issues

#20

Post by Dewie »

naholyr wrote: post #19
Dewie wrote: post #17

Earlier quoted context omitted.

> But a git hook is more portable. Are GitHub issues portable?

Ah ah nope, and that arised fast (issue #4) ;) But definitely, if you find it useless, then it certainly is for you! I was just telling why others could find it useful :)

> But definitely, if you find it useless,

I didn't say that. :/

Post reply on HN