Skip to content

Commit

Permalink
better issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremybosma authored and vapidinfinity committed Jul 27, 2024
1 parent d76cd55 commit 21ca015
Show file tree
Hide file tree
Showing 5 changed files with 98 additions and 51 deletions.
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: "Bug report"
description: Report an issue regarding Mythic.
title: "[bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
### Thanks for taking the time to create a bug report. Please search existing issues before submitting, as the issue may have already been addressed.
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, describe how in the description.
placeholder: Description of happened and what you expected to happen.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: How to reproduce
description: A step-by-step description of how to reproduce the bug.
placeholder: |
1. Go to '...'
2. Click on '....'
3. See error
validations:
required: true

- type: input
id: system-information
attributes:
label: Mac & App Information
description: Help us understand the environment of the bug by providing information about your system and the app.
placeholder: |
- Model: MacBook Air M2 16gb
- OS: macOS Sonoma 14.5
- App Version: 0.3.0
validations:
required: false

- type: textarea
id: logs
attributes:
label: Logs
description: "If applicable, provide logs that may help us understand the issue."
render: bash

- type: checkboxes
id: terms
attributes:
label: Before submitting
description: By submitting this issue, you confirm you did the following things.
options:
- label: I've made research efforts
required: true
- label: I've searched for existing issues
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: View documentation
url: https://docs.getmythic.app/
about: If you're looking for documentation on how to use Mythic, check out our documentation.
- name: Get Help on Discord
url: https://discord.gg/qbc32gtZDt
about: If you can't get something to work or just want to chat, join our Discord server.
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: "Feature request"
description: Create a feature request for Mythic.
title: "[feat]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
### Thanks for taking the time to create a feature request! Please search existing issues before submitting, as the issue may have already been addressed.
- type: textarea
id: feature-description
attributes:
label: Feature description
description: Tell us about your feature request
placeholder: "I think this feature would be nice to have because..."
value: "Describe your feature request..."
validations:
required: true

- type: checkboxes
id: terms
attributes:
label: Before submitting
description: By submitting this request, you confirm you did the following things.
options:
- label: I've made research efforts and searched the documentation
required: true
- label: I've searched for existing issues and PRs
required: true

0 comments on commit 21ca015

Please sign in to comment.