Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved issue templates #963

Merged
merged 4 commits into from
May 25, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: Bug report
description: Create a bug report to help us improve the plugin.
title: "[Bug]: "
labels: ["bug"]

body:
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: Tell us what happened that you didn't expect [...]
validations:
required: true
- type: textarea
id: bug-reproduce-steps
attributes:
label: To Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error"
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
placeholder: Tell us what you think should have happened...
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain the bug. This could be the logs in the developer console (`CTRL` + `SHIFT` + `i`).
placeholder: Paste image here
validations:
required: false
- type: input
id: operating-system
attributes:
label: OS of your device
placeholder: e.g. Win10
validations:
required: true
- type: input
id: obsidian-version
attributes:
label: Obsidian version
placeholder: e.g. v0.12.4
validations:
required: true
- type: input
id: plugin-version
attributes:
label: Plugin version
placeholder: "e.g. v1.4.9"
validations:
required: true
- type: input
id: installer-version
attributes:
label: Installer version
description: If on desktop [run `this.navigator.appVersion` on the developer console, e.g. `5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) obsidian/0.12.3 Chrome/89.0.4389.128 Electron/12.0.6 Safari/537.36"`]
placeholder: "e.g. v1.4.9"
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context about the problem here (e.g. the markdown producing the error).
placeholder: Explain any additional context [...]
validations:
required: false
- type: textarea
id: config-files
attributes:
label: Config file
description: |
Drag & drop your config file here [VAULT/.obsidian/plugins/obsidian-spaced-repetition/data.json]
Drag & drop your violated file containing your error here
placeholder: |
data.json
violated_file.md
validations:
required: false
16 changes: 0 additions & 16 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: Suggest an idea for this plugin.
title: "[FEAT]: "
labels: ["enhancement"]

body:
- type: textarea
id: problem-description
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is.
placeholder: I'm always frustrated when [...]
validations:
required: false
- type: textarea
id: solution-description
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
placeholder: I wanted that [...]
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
placeholder: Explain any additional context [...]
validations:
required: false
Loading