{"repo":"jolution/todo-nukem","free":true,"listed":false,"github":"https://github.com/jolution/todo-nukem","clone":"git clone https://github.com/jolution/todo-nukem.git","description":"Come get some!","language":null,"stars":36,"topics":["opensource","todo","todolist"],"license":"MIT","category":"productivity","readme_excerpt":"Coding Comments Convention Working Draft A specification for enhancing TODO messages with emojis for easier comprehension and organization. Usage Package IDE / Environment Description Status --------- ------------------- ------------- -------- VSCode Extension Visual Studio Code Generator, viewer and snippets for the TODO Nukem convention Alpha ESLint Rule ESLint Custom rule to validate the convention Alpha Copilot Instructions GitHub Copilot Instructions for using TODO Nukem convention with GitHub Copilot Alpha PR Ticket Link Action GitHub Actions Automatically adds ticket links to Pull Request descriptions based on branch names Alpha Technical integration Block-Commit (Commit Guard) The [block-commit] meta block is used to prevent a commit if this marker is present in the code. This is intended as a safety mechanism for critical TODOs that must be resolved before code can be committed. Note: This block does not work out of the box. You need to configure your tooling (e.g., git hooks) to enforce this rule. For example, with lefthook, you can block commits containing this marker. Example in source code: Visual display (with decorations): Example solution: Commit blocking with lefthook 📚 Summary The TODO NUKEM specification is a lightweight convention applied to TODO comment messages. It offers straightforward guidelines for crafting feature-rich comments, facilitating the development of automated tools. Designed for rapid visual comprehension of tasks, this convention may en","default_branch":null,"files":null,"tree":[],"storefront":"/r/jolution","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/jolution/todo-nukem/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}