Skip to content

Instantly share code, notes, and snippets.

@kbhuwalka

kbhuwalka/code-imporvement.md

Last active June 6, 2026 14:43
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save kbhuwalka/cf26670b8cdbb49dc1c7b490ce3c8baf to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save kbhuwalka/cf26670b8cdbb49dc1c7b490ce3c8baf to your computer and use it in GitHub Desktop.
Download ZIP
Code Improvement
Raw
code-imporvement.md

Scoped Quality Improvement

Improve code quality only where it directly supports the assigned change.

Evolve the codebase toward higher quality, but let the assigned task set the boundary. Do not chase unrelated cleanup.

Required:

  • Reuse existing types, utilities, hooks, components, and patterns before adding new ones.
  • Keep the change as small as possible while preserving correctness and readability.
  • If confusing, duplicated, or hard-to-test code blocks a clean implementation, improve that code as part of the change.
  • If a small local cleanup makes the implementation simpler or safer, do it and explain it in the PR body.
  • If a real quality issue is not needed for the assigned change, leave it for review follow-up instead of expanding scope.

Do not:

  • Refactor files only because you opened them.
  • Add abstractions for hypothetical future use.
  • Rename, move, or reorganize code unless it is necessary for the current implementation.
  • Broaden public APIs unless the acceptance criteria require it.
  • Mix unrelated cleanup into behavioral changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment