Never Forget a TODO Comment with tickgit, Your Repo's Project Manager

ticgit: A tool that helps you improve your code efficiency

ticgit is a command line tool and web application that scans TODO markers in source code and converts them into manageable tasks, enabling streamlined to-do management without having to work across tools Switch.

Core functions overview:

• Open source command line tool: tickgit is open source and can be used to query unfinished TODO comments, supports CSV output, and is convenient for integration with other tools. The features that are planned to be added in the future include: custom matching phrases, query and filtering, aggregation queries, CI patterns, link extraction, and custom annotation analysis.
• SaaS Web Application (ticckgit.com): This SaaS application integrates with GitHub to provide a platform to view unfinished TODO comments and aggregate statistics. Public warehouses are free to use, while private warehouses require a paid subscription. Future improvement plans include weekly email summary, improved query and filtering capabilities, support for more Git hosting platforms, and better integration with third-party tools.

How does tickgit work?

ticggit converts these code comments into tasks by scanning TODO markers in the source code (as well as HACK, FIXME, XXX, etc.), and provides more comprehensive context information in combination with Git history (such as who added it, and when it was added) , location, etc.).

Why choose tickgit?

Even a side project developed by independent developers, project management is an indispensable part of software development. Many existing ticket and task management systems can help teams and individuals track to-do items very thoroughly. However, sometimes using TODO comments and other tags in your code base becomes a more efficient way to track to-do items.

Advantages of TODO Annotations:

• Easy to use: Adding and removing TODO comments is very simple without leaving the code editor. They are plain text, can contain links to other information, and are very flexible, even using emojis ?✏️. You are not restricted by fields in external ticket systems and can describe the reasons for the comment code in detail or concisely as needed.
• No context switching required: TODO comments are directly next to the code they describe, meaning you don't lose the context of the code base: surrounding classes, functions, variables, etc. Using an external ticket system requires you to switch focus when trying to understand tickets and related code, or do a lot of contextual copying to help articulate your tasks.
• Synchronize with code: Since TODO comments are part of the code, they are stored in version control and can be reviewed in your PR. They have historical records that can be attributed to authors, versions, and submissions. This allows project management to generate reports on burn-out maps, team responsibilities, technical debt, development efficiency, and more.

Command line tool:

tickgit command line tool is an open source project for scanning TODO comments in the Git code base. It runs Git blame and outputs a reference result containing the file path and line number.

It can be used to query unfinished TODO comments on the fly and supports CSV output for use by other tools (spreadsheets, text processors, etc.).

ticgit.com Web Application:

ticgit Web Application is a SaaS that is currently integrated with GitHub. Free use of public warehouses (no registration required). You can view unfinished TODO comments along with some summary statistics, including a count chart by author and average age.

Each TODO comment is displayed as a card, and the information displayed is similar to the CLI. Clicking on the card will take you to the TODO commented files and lines in the GitHub UI.

Private warehouses charge USD 3 per month (individual users). All features of the free version (public warehouse) are available in the paid version (private warehouse).

FAQs:

(The FAQs part is omitted here because this part of the content is highly repetitive with the original text, pseudo-originality is more difficult and has a longer length. Some problems can be optionally rewritten according to needs.)

I hope this article can help you understand tickgit better!

The above is the detailed content of Never Forget a TODO Comment with tickgit, Your Repo's Project Manager. For more information, please follow other related articles on the PHP Chinese website!