Skip to content

CatanaCorp/docs

Repository files navigation

cover coverY
.gitbook/assets/cover.jpg
0

Introduction

Catana is a tool to help manage and prevent TODOs from turning into technical debt.

It enhances developers' annotations with a set of features and conventions, all while helping project owners maintain a comprehensive overview of the health of their codebases across their organization.

Your projects deserve a better alternative than restricting or leaving TODOs growing out of control.

Leaving TODOs unmanaged

The accumulation of unresolved TODOs contributes to the long-term maintenance overhead of your projects. What originally was an innocent TODO could transform into a technical debt, slowing you down at best or even creating a security incident in the worst-case scenario.

Without proper tooling, TODOs are hard to remember for developers, time-consuming to track down for team members, and nearly impossible to manage for project owners.

Restricting TODOs

In an attempt to tackle the inherent problems associated with writing TODOs, organizations may be tempted to resort to a drastic measure: restrict TODOs with a linter before they land on the release branch.

Because a TODO is often insufficiently specific to justify opening an issue, restricting its usage and inciting creating a ticket may lead developers to take a mental note instead. A mental note is a recipe for catastrophe.

In large projects with often hundreds of opened tickets, an issue tracker is already difficult to manage. Overloading it with “TODOs converted to issues” will bury them even deeper.

Major software organizations (Google, Cloudflare, Stripe, Shopify…) allow TODOs in their codebases for a reason: A TODO and an issue tracker have different uses, and solely using one over the other is not a solution.

Introducing Catana

Catana was designed to solve the three inherent problems of TODOs:

  • Difficult to remember.
  • Hard to find.
  • Painful to manage.

Existing and upcoming TODOs on all your projects are recorded with detailed information in the background.

Each TODOs gets assigned (automatically or manually) and Catana either reminds its assignee discreetly by email or more loudly when a TODO is actionable.

TODOs on all projects across your organization are presented on a dedicated and comprehensive dashboard.
Catana also offers multiple features to save developers’ time and automate tedious tasks.

\

Releases

No releases published

Packages

No packages published