aboutsummaryrefslogtreecommitdiff
path: root/review-code
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-04-22 14:51:55 -0500
committerCraig Jennings <c@cjennings.net>2026-04-22 14:51:55 -0500
commitd6e558878ad840bf8d4ca0f66c5978a48968ab95 (patch)
tree28ce9c99870a48fef0d14145dc394f8332eb9122 /review-code
parent1fb4232671d30aa867e3e7b0c74d48a989e460c5 (diff)
downloadrulesets-d6e558878ad840bf8d4ca0f66c5978a48968ab95.tar.gz
rulesets-d6e558878ad840bf8d4ca0f66c5978a48968ab95.zip
docs(commits): add Voice and Focus, expand humanizer checklist
Added a new Voice and Focus section between Commit Message Format and Review and Publish. It covers three rules that kept coming up in practice. Write in the user's voice — first person fits, and "This PR introduces X" reads as press-release self-narration. Focus on what was wrong and what was corrected, not the mechanics. Don't stack three or more type signatures or API names in a single sentence. Also extended the post-humanizer checklist in both the commit-message and PR-description flows. Items (c) "prefer contractions" and (d) "break up long sentences" now sit alongside the existing (a) "rewrite dev-jargon" and (b) "replace semicolons". Uncontracted English reads stiff in short prose, and stacked-clause sentences read easier split on a conjunction.
Diffstat (limited to 'review-code')
0 files changed, 0 insertions, 0 deletions