DEV Community

Discussion on: Stop Committing TODOs

Collapse
jlhcoder profile image
James Hood

My teams use checkstyle at build time and will fail the build on checkstyle errors. I added a custom checkstyle rule that will fail if it sees a TODO comment that doesn't reference an issue tracker issue.

As long as the team's small and bought into it, I've found it results in just the right amount of friction such that if you're just pushing something small off until later, the pain of opening an issue and writing out what needs to be done is equal or greater than just doing the TODO. But if it's sufficiently large, then it gets tracked in the issue tracker.

Again, there are plenty of ways to game this kind of system so the team needs to be bought in. The checkstyle rule just serves as a reminder.