diff --git a/.github/ISSUE_TEMPLATE/bug_report_inputs.yml b/.github/ISSUE_TEMPLATE/bug_report_inputs.yml index b330b3a..55bee89 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_inputs.yml +++ b/.github/ISSUE_TEMPLATE/bug_report_inputs.yml @@ -1,6 +1,6 @@ # https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms # https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema -name: Bug Report +name: Bug report (inputs) description: File a bug report title: "[Bug]: " labels: ["bug", "triage"] diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 28fcf56..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,5 +0,0 @@ - - -This is a test template diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE2.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE2.md deleted file mode 100644 index 28fcf56..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE2.md +++ /dev/null @@ -1,5 +0,0 @@ - - -This is a test template diff --git a/.github/PULL_REQUEST_TEMPLATE/ccc.md b/.github/PULL_REQUEST_TEMPLATE/ccc.md new file mode 100644 index 0000000..13f5039 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/ccc.md @@ -0,0 +1,53 @@ + + +# Code Change Control + +## Description + +Please include a summary of the change and which issue is fixed. Please provide the motivation for why this change is necessary at this stage of the product development cycle. + +Fixes # (issue) + +## Customer Impact + +Please describe any customer facing impact of this change. This can be positive or negative impact. + +## Performance Impact + +Please describe any relevant performance impact of this change. This can be positive or negative impact. How did you characterize/test the performance impact? + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so others can reproduce. Please also list any relevant details for your test configuration. + +- [ ] Test A +- [ ] Test B + +**Hardware Configuration(s) Tested**: + +**Software Configuration(s) Tested**: + +* Operating System: +* Software version: +* Branch: +* Toolchain version: +* SDK version: + +## Reviews + +Please identify two developers to review this change + +- [ ] @personA +- [ ] @personB + +## Checklist: + +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] 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 +- [ ] Any dependent changes have been merged and published in downstream modules diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..3a8567d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,46 @@ + + +# Pull Request + +## Description + +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 # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] 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? + +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 A +- [ ] Test B + +**Test Configuration(s)**: + +* Firmware version: +* Hardware: +* Toolchain: +* SDK: + +## Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] 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 +- [ ] Any dependent changes have been merged and published in downstream modules +- [ ] I have checked my code and corrected any misspellings diff --git a/README.md b/README.md index 848bff9..b1d092d 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,5 @@ https://github.com/joelparkerhenderson/github-special-files-and-paths#changelog https://github.com/segraef/Template https://github.com/Azure/Aks-Construction + +https://github.com/embeddedartistry