Merge pull request #111 from leemgs/upstream-pr-template

github: added PULL_REQEUEST_TEMPLATE for PR maintenance
This commit is contained in:
Fred de Gier 2023-01-02 11:04:44 +01:00 committed by GitHub
commit 8df5058c5c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

27
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,27 @@
---
# [Template] PR Description
In general, the github system duplicates your commit message automatically for your convenience.
After composing your own PR description using this template, please remove any unneeded portions.
```bash
## 1. General Description
The commit title must begin with one of the eleven given options.
Build, chore, CI, documentation, task, fix, performance, refactor, revert, style, and test are some examples.
or more details, please see [HERE](https://www.conventionalcommits.org/en/v1.0.0/).
Summarize changes in no more than 50 characters ASAP for readability and maintenance.
## 2. Changes proposed in this PR:
- Bulleted lists are also acceptable.
- Typically, a hyphen or asterisk before the bullet, followed by a single space.
Resolves: #{GitHub-Issue-Number}
See also: #{GitHub-Issue-Number}
## 3. How to evaluate:
1. Describe how to evaluate such that it may be reproduced by the reviewer (s).
2. Self assessment:**
- Build test: [ ]Passed [ ]Failed [*]Skipped
- Run test: [ ]Passed [ ]Failed [* ]Skipped
```