From b56b69df2cff934ed79d3617890867a8fe1be4e6 Mon Sep 17 00:00:00 2001 From: Aaron DeRuvo Date: Wed, 30 Oct 2024 11:45:22 +0100 Subject: [PATCH] simplify the pr template (#411) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### Description Template had too many sections which were never use. keep it simple. keep it clean. keep it useful --- ## PR-Codex overview This PR updates the pull request template in the `.github/pull_request_template.md` file to enhance clarity and structure, particularly in the explanation of changes and their implications. ### Detailed summary - Changed the prompt from "A few sentences describing the overall effects and goals..." to "Tell us why these changes are being made". - Updated section header from "### Other changes" to "#### Other changes". - Added a note to delete the "Other changes" section if none exist. - Removed the "### Backwards compatibility" and "### Documentation" sections from the template. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` --- .github/pull_request_template.md | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 43b60853b..ceb6e1150 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,11 +1,10 @@ ### Description -_A few sentences describing the overall effects and goals of the pull request's commits. -What is the current behavior, and what is the updated/expected behavior with this PR?_ +_Tell us why these changes are being made_ -### Other changes +#### Other changes -_Describe any minor or "drive-by" changes here._ +_Describe any minor or "drive-by" changes here. If none delete this section_ ### Tested @@ -14,11 +13,3 @@ _An explanation of how the changes were tested or an explanation as to why they ### Related issues - Fixes #[issue number here] - -### Backwards compatibility - -_Brief explanation of why these changes are/are not backwards compatible._ - -### Documentation - -_The set of community facing docs that have been added/modified because of this change_ \ No newline at end of file