From b312242cb8c190b5e90fdb31014a09cf2fbb0b92 Mon Sep 17 00:00:00 2001 From: Dan Albert Date: Sun, 16 Jan 2022 13:59:26 -0800 Subject: [PATCH] Remind PR authors about the changelog. I suspect we'll still be writing most of these ourselves, but might as well point it out for the people that want to. --- .github/pull_request_template.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 022bad3c..b5a559b0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,2 +1,9 @@ Pull requests should be made against the `develop` branch. Any backports necessary will be handled by the development team. + +New features and bug fixes are usually worth mentioning in the changelog. +Exceptions are fixes for bugs that never shipped (were only present in a canary +build), and changes with no intended user observable behavior, such as a +refactor. If you're comfortable writing the note yourself, add it to +`changelog.md` in the root of the project in the section for the upcoming +release.