diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3dfe4437..5cd739a8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,27 +1,26 @@ # Description +*Please include a summary of the change and which issue is fixed, as well as relevant motivation and context. Finally, list any dependencies that are required for this change if any.* -Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - -Fixes # +Fixes: # ## Type of change -Please delete options that are not relevant. - +- [ ] Refactor (non-breaking change which improves code quality or performance) - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update -# How has this been tested? +## How has this been tested? Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration **Test configuration**: -* Firmware version: -* Yubikey model: +* OS version: *e.g. Windows 11* +* Firmware version: *e.g. 5.7.2* +* Yubikey model[^1]: -# Checklist: +## Checklist: - [ ] My code follows the [style guidelines](https://raw.githubusercontent.com/Yubico/Yubico.NET.SDK/043119ad1d19e0e6e66556c970a81d0c1aba36c8/CONTRIBUTING.md) of this project - [ ] I have performed a self-review of my own code @@ -31,3 +30,5 @@ Please describe the tests that you ran to verify your changes. Provide instructi - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes + +[^1]: See [Yubikey models](https://www.yubico.com/products/) (Multi-protocol, Security Key, FIPS, Bio, YubiHSM, YubiHSM FIPS)