mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2025-02-20 13:46:52 +01:00
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>
This commit is contained in:
parent
08f17dab0b
commit
e9fda9653d
2
.github/CONTRIBUTING.md
vendored
2
.github/CONTRIBUTING.md
vendored
|
|
@ -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
|
||||
|
||||
|
|
|
|||
11
.github/PULL_REQUEST_TEMPLATE.md
vendored
11
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -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*]
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user