From e9fda9653db908dd8f30df215a0d1977534ccae8 Mon Sep 17 00:00:00 2001 From: William Mead Date: Mon, 23 Oct 2023 19:00:03 +0200 Subject: [PATCH] New perf & qual sections for PR template (#26328) * NEW performance & code quality enhancements template sections * Reordered commit keyword categories to match pull request template * Adjusted instructions --------- Co-authored-by: William Mead --- .github/CONTRIBUTING.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 11 ++++++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 280dc3a83cc..75b500c0849 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -69,8 +69,8 @@ In uppercase if you want to have the log comment appears into the generated Chan The keyword can be ommitted if your commit does not fit in any of the following categories: - Fix/FIX: for a bug fix -- New/NEW: for an unreferenced new feature (Opening a feature request and using close is prefered) - Close/CLOSE: for closing a referenced feature request +- New/NEW: for an unreferenced new feature (Opening a feature request and using close is prefered) - Perf/PERF: for performance enhancement - Qual/QUAL: for quality code enhancement or re-engeneering diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 13a3e6fa77b..494ae84c972 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,7 @@ # Instructions *This is a template to help you make good pull requests. You may use [Github Markdown](https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/) syntax to format your issue report.* *Please:* -- *only keep the "FIX", "CLOSE" or "NEW" section* (use uppercase to have the PR appears into the ChangeLog, lowercase will not appears) +- *only keep the "FIX", "CLOSE", "NEW", "PERF" or "QUAL" section* (use uppercase to have the PR appears into the ChangeLog, lowercase will not appears) - *follow the project [contributing guidelines](/.github/CONTRIBUTING.md)* - *replace the bracket enclosed texts with meaningful information* @@ -16,3 +16,12 @@ # NEW|New [*Short description*] [*Long description*] + + +# PERF|Perf #[*issue_number Short description*] +[*Long description*] + + +# QUAL|Qual #[*issue_number Short description*] +[*Long description*] +