tiime-software/technical-debt-tracker

Tiime software's technical debt tracker

1.0.2 2023-12-29 08:34 UTC

Requires

• php: ^7.4 || ^8.0
• ext-json: *
• ext-tokenizer: *
• doctrine/annotations: ^1.10
• doctrine/lexer: ^1.2 || ^2
• haydenpierce/class-finder: ^0.4.2
• phpstan/phpdoc-parser: ^1.2

Requires (Dev)

• phpunit/phpunit: ^9.1
• squizlabs/php_codesniffer: ^3.6
• staabm/annotate-pull-request-from-checkstyle: ^1.7
• vimeo/psalm: ^4.15

MIT

• Lucas GERARD
• Flavien RODRIGUES

README

As with monetary debt, if technical debt is not repaid, it can accumulate 'interest', making it harder to implement changes.

🐿️ In a nutshell

Use PHP annotations (docblocks annotations) to monitor your technical debt.

/**
  * @TechnicalDebt(
  *     categories={"tightly coupled", "lack of test"}, 
  *     reporter="Flavien Rodrigues", 
  *     description="Lorem ipsum sit dolor amet"
  * )
  */
class DummyService
{
    // ...
}

Then run our script as CI step and record the result into your monitoring tool.

vendor/bin/technical-debt-tracker

💯 Ranked categories

By default, we provide these common categories

📉 Technical debt monitoring

Our practice is to visualize technical debt over time (purple line). We add a trending line (grey) and define the point where updating the codebase will be impossible (red line). Now it's also possible to define SMART goals (green line).