Skip to content

Commit

Permalink
Issues and PR templates (#382)
Browse files Browse the repository at this point in the history
  • Loading branch information
soumeh01 authored Nov 18, 2024
1 parent efb6ca8 commit dbcb4b6
Show file tree
Hide file tree
Showing 3 changed files with 180 additions and 0 deletions.
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/blocker.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: Blocking Bug Report
description: File a report for a blocking bug, i.e., issues that can't be worked around.
title: "[Blocker]: "
labels: ["bug", "critical"]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Unusable feature
description: Which feature(s) of CMSIS-Toolbox becomes unusable due to this bug?
validations:
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
validations:
required: false
- type: checkboxes
attributes:
label: Affected tools
description: Which tools are affected by this bug?
options:
- label: cbuild
required: false
- label: cbuild2cmake
required: false
- label: cpackget
required: false
- label: csolution
required: false
- label: packchk
required: false
- label: svdconv
required: false
- type: checkboxes
attributes:
label: Affected operating systems
description: On which host os platforms does the bug occur?
options:
- label: Windows amd64
required: false
- label: Windows arm64
required: false
- label: Linux amd64
required: false
- label: Linux arm64
required: false
- label: MacOS amd64
required: false
- label: MacOS arm64
required: false
- type: textarea
attributes:
label: Environment
description: Give more details about the affected operating system(s), e.g. distribution and version.
placeholder: |
- Ubuntu 22.04
- Windows 10 Version 22H2 (Build ...)
validations:
required: false
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Bug Report
description: File a report for a non-blocking bug, i.e., issues that can be worked around.
title: "[Bug]: "
labels: ["bug"]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
validations:
required: false
- type: checkboxes
attributes:
label: Affected tools
description: Which tools are affected by this bug?
options:
- label: cbuild
required: false
- label: cbuild2cmake
required: false
- label: cpackget
required: false
- label: csolution
required: false
- label: packchk
required: false
- label: svdconv
required: false
- type: checkboxes
attributes:
label: Affected operating systems
description: On which host os platforms does the bug occur?
options:
- label: Windows amd64
required: false
- label: Windows arm64
required: false
- label: Linux amd64
required: false
- label: Linux arm64
required: false
- label: MacOS amd64
required: false
- label: MacOS arm64
required: false
- type: textarea
attributes:
label: Environment
description: Give more details about the affected operating system(s), e.g. distribution and version.
placeholder: |
- Ubuntu 22.04
- Windows 10 Version 22H2 (Build ...)
validations:
required: false
18 changes: 18 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Fixes
<!-- List the issue(s) this PR resolves -->

-

## Changes
<!-- List the changes this PR introduces -->

-

## Checklist
<!-- Put an `x` in the boxes. All tasks must be completed and boxes checked before merging. -->

- [ ] 🤖 This change is covered by unit tests as required.
- [ ] 🤹 All required manual testing has been performed.
- [ ] 🛡️ Security impacts have been considered.
- [ ] 📖 All documentation updates are complete.
- [ ] 🧠 This change does not change third-party dependencies

0 comments on commit dbcb4b6

Please sign in to comment.