Zum Inhalt springen
Kitbay
Skill

reviewing-readability

Apache-2.0Aktualisiert am 11. Nov. 202646.309GitHub-Sterne

A review skill kept in the Streamlit repository that checks the comments, docstrings and names in a pull request, branch or change set for how clear they would be to a developer new to the codebase.

Was der Skill vermittelt

A review skill kept in the Streamlit repository that checks the comments, docstrings and names in a pull request, branch or change set for how clear they would be to a developer new to the codebase. The agent collects every comment, docstring and name in scope, tests each against principles such as explaining intent rather than mechanics, leading with the main idea, defining project jargon, active voice and self-explanatory names, and looks for complex logic with no explanation. It reports findings by file with a concrete rewrite or a comment to add, does not rank them, and does not apply them itself. Type annotations, correctness warnings, needed reference links and legal headers are left alone.

Funktionen

  • Review comments and docstrings for clarity
  • Suggest clearer names for functions and tests
  • Flag complex logic with no explanation
  • Propose concrete rewrites by file