diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a86c2873..6d193065 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,2 +1,50 @@ + + ### Does your PR solve an issue? -### Delete this text and add "fixes #(issue number)" +Delete this text and add "fixes #(issue number)". + +Do *not* just list issue numbers here as they will not be automatically closed on merging this pull request unless prefixed with "fixes" or "closes". + +### Is this a breaking change? +Delete this text and answer yes/no and explain. + +If yes, this pull request will need to wait for the next major release (`0.{x + 1}.0`) + +Behavior changes _can_ be breaking if significant enough. +Consider [Hyrum's Law](https://www.hyrumslaw.com/): + +> With a sufficient number of users of an API, +> it does not matter what you promise in the contract: +> all observable behaviors of your system +> will be depended on by somebody.