tiime-software / technical-debt-tracker
Tiime software's technical debt tracker
Installs: 426 039
Dependents: 0
Suggesters: 0
Security: 0
Stars: 5
Watchers: 1
Forks: 1
Open Issues: 0
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-03-29 09:13:16 UTC
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
| Category | Score | Description |
|---|---|---|
| security issue | 500 | |
| hard to understand | 200 | |
| tightly coupled | 150 | Where functions are not modular, the software is not flexible enough to adapt to changes in business needs. |
| need tests | 150 | |
| delayed refactoring | 100 | As the requirements for a project evolve, it may become clear that parts of the code have become inefficient or difficult to edit and must be refactored in order to support future requirements. The longer refactoring is delayed, and the more code is added, the bigger the debt. |
| core feature | 50 | Add penalty on applications's critical parts |
| need documentation | 10 | Where code is created without supporting documentation. The work to create documentation represents debt |
| bad practice | 5 | Where industry standard features, frameworks, technologies are ignored. Eventually integration with standards will come, and doing so sooner will cost less |
| wip | 5 | Work in progress |
📉 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).
