Browse Source

Complete PR template

Laurent Destailleur 3 years ago
parent
commit
1d9b6fc500
1 changed files with 4 additions and 4 deletions
  1. 4 4
      .github/PULL_REQUEST_TEMPLATE.md

+ 4 - 4
.github/PULL_REQUEST_TEMPLATE.md

@@ -1,18 +1,18 @@
 # 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*
+- *only keep the "FIX", "CLOSE" or "NEW" 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*
 
 
-# Fix #[*issue_number Short description*]
+# FIX|Fix #[*issue_number Short description*]
 [*Long description*]
 
 
-# Close #[*issue_number Short description*]
+# CLOSE|Close #[*issue_number Short description*]
 [*Long description*]
 
 
-# New [*Short description*]
+# NEW|New [*Short description*]
 [*Long description*]