Zum Inhalt springen
Kitbay
Skill

reviewing-pr-description

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

A review skill kept in the Streamlit repository that checks whether a pull request's title and description tell a reviewer clearly and briefly what changed and why, since they later end up in commit logs and changelogs.

Was der Skill vermittelt

A review skill kept in the Streamlit repository that checks whether a pull request's title and description tell a reviewer clearly and briefly what changed and why, since they later end up in commit logs and changelogs. It fetches the pull request with the GitHub CLI, checks the text against nine principles such as leading with the change and its purpose, explaining intent rather than mechanics, leaving out what the diff already shows, using active voice and removing meta-commentary, and then checks format: a type prefix with a title of about 63 characters and the template's required sections. It reports each problem with a concrete rewrite and never edits the pull request itself.

Funktionen

  • Review a pull request title and description
  • Check the description against a template
  • Propose concrete rewrites