From 2d77902206adcecc942f1e319e23223a09da6328 Mon Sep 17 00:00:00 2001 From: Kirubel Tadesse Date: Fri, 29 Sep 2023 23:19:56 +0100 Subject: [PATCH] change new-feature template to yml --- .github/ISSUE_TEMPLATE/bug.yml | 4 +- .github/ISSUE_TEMPLATE/feature_request.md | 20 --------- .github/ISSUE_TEMPLATE/feature_request.yml | 38 +++++++++++++++++ .github/pull_request_template.md | 47 ++++++++++++++++++++++ .github/pull_request_template.yml | 37 ----------------- .github/settings.yml | 2 +- 6 files changed, 88 insertions(+), 60 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.md delete mode 100644 .github/pull_request_template.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 4cdf2f3..a5d358a 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,8 +1,8 @@ name: Bug description: File a bug report title: "[BUG] " -labels: ["bug", "cicd", "ui", "core"] -projects: ["Swarmies/Shoes Project"] +labels: ["bug", "documentation", "core", "enhancement"] +projects: ["Shoes Project"] assignees: - kirubeltadesse - roberamelaek diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..ff6223c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,38 @@ +name: Feature request +description: Suggest an idea for this project +title: "name of new feature" +labels: ["new-feature"] + +body: + - type: textarea + id: description + attributes: + label: description + description: your feature request related to a problem? Please describe.** + placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + - type: textarea + id: solution + attributes: + label: solution + description: Describe the solution you'd like + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternative + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: textarea + attributes: + label: Additional context? + description: | + Links? References? Anything that will give us more context about the feature you are requesting! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..d40cf87 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,47 @@ +--- +name: "feat(core): <description>" +about: "Use this template for setting up your PR description" +title: "Add support for the new feature" +labels: bug, enhancement, customer-request +assignees: self +--- + +# Description + +Please include a summary of the change and which issue is fixed. Please also have relevant motivation and context. Could you 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 not to 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. Could you provide instructions so we can reproduce them? 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 code +- [ ] I have commented on 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.yml b/.github/pull_request_template.yml deleted file mode 100644 index 733070e..0000000 --- a/.github/pull_request_template.yml +++ /dev/null @@ -1,37 +0,0 @@ -body: - - type: textarea - id: description - attributes: - label: Description - description: Please include a summary of the change and which issue is fixed. Please also have relevant motivation and context. Could you list any dependencies that are required for this change? - placeholder: Fixes # (issue) - - type: checkboxes - attributes: - label: Type of change - description: Please delete options that are not relevant. - options: - - label: Bug fix (non-breaking change which fixes an issue) - - label: New feature (non-breaking change which adds functionality) - - label: Breaking change (fix or feature that would cause existing functionality not to work as expected) - - label: This change requires a documentation update - - type: textarea - id: test - attributes: - label: How Has This Been Tested? - description: Please describe the tests that you ran to verify your changes. Could you provide instructions so we can reproduce them? Please also list any relevant details for your test configuration. - placeholder: | - - [ ] Test A - - [ ] Test B - - type: markdown - attributes: - label: checklist - description: check this list before opening a PR - value: | - - [ ] My code follows the style guidelines of this project - - [ ] I have performed a self-review of my code - - [ ] I have commented on 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/settings.yml b/.github/settings.yml index b3c4416..b933d83 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -23,7 +23,7 @@ repository: has_downloads: true # Updates the default branch for this repository. - default_branch: develop + default_branch: main # Either `true` to allow squash-merging pull requests, or `false` to prevent # squash-merging.