From 4c68126295d65046093353806345a02dfb7e1d10 Mon Sep 17 00:00:00 2001 From: Anton Osika Date: Tue, 20 Jun 2023 22:21:29 +0200 Subject: [PATCH] Simplify templates --- .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md | 20 +-------- .../PULL_REQUEST_TEMPLATE.md | 43 +++---------------- 2 files changed, 7 insertions(+), 56 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md index 869ae4c..9ee39b9 100644 --- a/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md @@ -1,23 +1,7 @@ +**YOU MAY DELETE THE ENTIRE TEMPLATE BELOW.** + # Issue Template -## Prerequisites - -Please answer the following questions for yourself before submitting an issue. **YOU MAY DELETE THE PREREQUISITES SECTION.** - -- [ ] I am running the latest version -- [ ] I checked the documentation and found no answer -- [ ] I checked to make sure that this issue has not already been filed -- [ ] I'm reporting the issue to the correct repository (for multi-repository projects) - -## Context - -Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions. - -* Firmware Version: -* Operating System: -* SDK version: -* Toolchain version: - ## Expected Behavior Please describe the behavior you are expecting. diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md index 32fb126..8a9cae2 100644 --- a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md @@ -1,41 +1,8 @@ -# Pull Request Template - -## 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 +**YOU MAY DELETE THE ENTIRE TEMPLATE BELOW.** ## 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**: -* 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 +Please describe if you have either: +- Generated the "example" project +- Ran the entire benchmark suite +- Something else