Merge pull request #10645 from Kilo-Org/vivacious-soap

docs: allow detailed PR descriptions
This commit is contained in:
Marius
2026-05-28 10:39:53 +02:00
committed by GitHub
+1 -1
View File
@@ -219,7 +219,7 @@ Changeset descriptions appear directly in release notes and are read by end user
## Pull Requests
PR descriptions should be 2-3 lines covering **what** changed and **why**. Focus on intent and context a reviewer can't get from the diff — skip file-by-file inventories, test result summaries, and anything obvious from the code itself.
PR descriptions should explain **what** changed, **why** the change is needed, and the intent or constraints a reviewer cannot infer from the diff alone. Keep simple PRs brief, but give non-trivial changes enough context to stand on their own. Skip file-by-file inventories, test result summaries, and anything obvious from the code itself.
## GitHub Issues