tiime-software / technical-debt-tracker
Tiime软件的技术债务跟踪器
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
This package is auto-updated.
Last update: 2024-08-29 10:04:04 UTC
README
与货币债务一样,如果技术债务不偿还,它可能会积累“利息”,使得实施更改变得更加困难。
🐿️ 简而言之
使用PHP注释(docblocks注释)来监控您的技术债务。
/** * @TechnicalDebt( * categories={"tightly coupled", "lack of test"}, * reporter="Flavien Rodrigues", * description="Lorem ipsum sit dolor amet" * ) */ class DummyService { // ... }
然后作为CI步骤运行我们的脚本,并将结果记录到您的监控工具中。
vendor/bin/technical-debt-tracker
💯 排名类别
默认情况下,我们提供以下常见类别
📉 技术债务监控
我们的做法是将技术债务随时间可视化(紫色线)。我们添加趋势线(灰色)并定义更新代码库将变得不可能的点(红色线)。现在还可以定义SMART目标(绿色线)。