From a5df9e9b0406d868d8e376d3272c4f9c1c21ff36 Mon Sep 17 00:00:00 2001 From: Gino Valente Date: Thu, 4 Jul 2024 17:06:46 -0700 Subject: [PATCH] Remove Changelog section --- .github/pull_request_template.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 58e3a6efa9dfa3..82446ac5b4dd0c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -24,7 +24,7 @@ - If this PR adds a new feature or public API, consider adding a brief pseudo-code snippet of it in action - If this PR includes a visual change, consider adding a screenshot, GIF, or video - If you want, you could even include a before/after comparison! -- If the Changelog or Migration Guide adequately cover the changes, you can delete this section +- If the Migration Guide adequately covers the changes, you can delete this section While a showcase should aim to be brief and digestible, you can use a toggleable section to save space on longer showcases: @@ -37,15 +37,6 @@ println!("My super cool code."); -## Changelog - -> This section is optional. If this was a trivial fix, or has no externally-visible impact, you can delete this section. - -- What changed as a result of this PR? -- If applicable, organize changes under "Added", "Changed", or "Fixed" sub-headings -- Stick to one or two sentences. If more detail is needed for a particular change, consider adding it to the "Solution" section - - If you can't summarize the work, your change may be unreasonably large / unrelated. Consider splitting your PR to make it easier to review and merge! - ## Migration Guide > This section is optional. If there are no breaking changes, you can delete this section.