Browse Source

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 <william.mead@manchenumerique.fr>
William Mead 1 year ago
parent
commit
e9fda9653d
2 changed files with 11 additions and 2 deletions
  1. 1 1
      .github/CONTRIBUTING.md
  2. 10 1
      .github/PULL_REQUEST_TEMPLATE.md

+ 1 - 1
.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
 

+ 10 - 1
.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*]
+