Back to all reviewers

Document performance tool lifecycle

kilo-org/kilocode
Based on 2 comments
Markdown

When creating performance optimization tools, especially temporary dev-only utilities, clearly document their purpose, scope, and removal criteria in the README or documentation. This helps teams make informed decisions about maintenance vs. performance benefits over time.

Performance Optimization Markdown

Reviewer Prompt

When creating performance optimization tools, especially temporary dev-only utilities, clearly document their purpose, scope, and removal criteria in the README or documentation. This helps teams make informed decisions about maintenance vs. performance benefits over time.

Include these key elements:

  • Mark dev-only tools explicitly (e.g., โ€œInternal dev tool only:โ€)
  • State the performance problem being solved
  • Define clear criteria for when the tool should be removed
  • Acknowledge the temporary nature of the optimization

Example documentation:

# Translation MCP Server

**Kilocode internal dev tool only:** This is a performance optimization to reduce LLM waiting time during translation tasks. Can be deleted when maintenance burden outweighs time saved.

This approach prevents performance tools from becoming technical debt by establishing upfront expectations about their lifecycle and making it easier for future developers to evaluate whether the optimization is still worthwhile.

2
Comments Analyzed
Markdown
Primary Language
Performance Optimization
Category

Source Discussions