trufflehog
trufflehog copied to clipboard
Add TODO.md for Centralized TODO's Tracking
Please review the Community Note before submitting
Description
Proposing the addition of a TODO.md file to the repository as a centralized location to track all TODOs within the codebase.
Preferred Solution
Implement a script to automatically populate TODO.md. This script would search for comments formatted as // TODO: <> within the codebase and add them to TODO.md. The script can be run via a make todo command, enabling developers to easily update the file whenever TODOs are added or resolved in the codebase.
Additional Context
This approach would help developers and contributors to track and prioritize TODOs, enabling contributors to pick up tasks more easily.
References
Github projects or discussions should be a better fit for this, Like caido team uses https://github.com/orgs/caido/projects/4/views/20
@bugbaba GitHub Projects or Discussions are great for broader task and feature tracking or collaborative discussions, but the todo.md file is mainly for tracking tech debt and smaller, code-specific tasks that are closely related to the codebase.
I'll try to create a draft PR soon and if it looks good we can include it :)
Gonna close this as it's another piece of code to maintain when ctrl-f TODO works just fine.