CQ003: NoTODOsInCode

Overview

Property Value
ID CQ003
Name NoTODOsInCode
Group code-quality
Severity NOTE

Description

Checks for TODO and FIXME comments in Python files.

TODO comments indicate incomplete work that should be tracked:

  • Unfinished features
  • Known bugs to fix
  • Technical debt

What it checks

The check scans all .py files for comments containing:

  • TODO (case-insensitive)
  • FIXME (case-insensitive)

Reports the count and locations of all found items.

How to fix

Address the TODOs

Review each TODO and either:

  1. Complete the work - Implement the missing functionality
  2. Create an issue - Track it in your issue tracker instead
  3. Remove if obsolete - Delete if no longer relevant

Convert to issues

Instead of TODO comments, create GitHub issues:

# Instead of:
# TODO: Add caching support

# Create an issue and reference it:
# See: https://github.com/user/repo/issues/123

Use a TODO tracker

Tools like todo-tracker or IDE plugins can help manage TODOs.

Why NOTE severity?

This check is a NOTE because:

  • TODOs are sometimes intentional markers
  • Not all TODOs need immediate attention
  • Some teams use TODOs as part of their workflow

Configuration

Skip this check

[tool.pycmdcheck]
skip = ["CQ003"]

CLI

pycmdcheck --skip CQ003