mirror of
https://github.com/mudnug/note-reader.git
synced 2026-07-22 06:41:36 +00:00
Add issue templates
This commit is contained in:
parent
68d67ea34a
commit
291ba8d00e
2 changed files with 179 additions and 0 deletions
114
.github/ISSUE_TEMPLATE/bug-report.yaml
vendored
Normal file
114
.github/ISSUE_TEMPLATE/bug-report.yaml
vendored
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
name: Bug report
|
||||
description: Document a bug in note-reader
|
||||
labels: ["type: bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Before you start
|
||||
|
||||
Thanks for taking the time to report a bug in **note-reader**!
|
||||
|
||||
To help us reproduce and fix the issue quickly, please:
|
||||
|
||||
- Make sure you’re using the **latest version of note-reader**.
|
||||
- Include **clear steps to reproduce** and any relevant error messages.
|
||||
|
||||
- type: checkboxes
|
||||
id: no-invalid-issues
|
||||
attributes:
|
||||
label: "Verify your issue is in the right place"
|
||||
description: "This repository is only for the note-reader plugin, not the Obsidian app itself."
|
||||
options:
|
||||
- label: "My request is about the note-reader plugin for Obsidian (not core Obsidian or another plugin)."
|
||||
required: true
|
||||
- label: "I have tested with the latest released version of the note-reader plugin."
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: no-duplicate-issues
|
||||
attributes:
|
||||
label: "⚠️ Check that this issue hasn't been reported already"
|
||||
description: "A quick search through existing bug reports can save everyone time."
|
||||
options:
|
||||
- label: "I searched existing note-reader bug reports and didn’t find a similar issue."
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reproduce
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: |
|
||||
What exact steps can we follow to reproduce the issue?
|
||||
|
||||
The more specific you are, the easier it is for us to track down the problem.
|
||||
Please include any relevant content as text, so we can copy and test it.
|
||||
placeholder: |
|
||||
Example:
|
||||
|
||||
1. Launch Obsidian Sandbox via the `Open Sandbox Vault` command.
|
||||
2. Install the note-reader plugin.
|
||||
4. Create a new note called `Demo problem`.
|
||||
5. Paste in a task with the text `- [x] Some special problem text`.
|
||||
6. Attempt to switch to Reading mode.
|
||||
5. Observe that ...
|
||||
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: Tell us what you expected to happen when following the steps above.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: Actual behavior
|
||||
description: |
|
||||
Tell us what actually happens instead of the expected behavior.
|
||||
Screenshots or short screen recordings are very helpful if you can provide them.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: operating-systems
|
||||
attributes:
|
||||
label: Which operating systems are you using?
|
||||
description: You can select more than one option if applicable.
|
||||
options:
|
||||
- label: Linux
|
||||
- label: macOS
|
||||
- label: Windows
|
||||
validations:
|
||||
required: true
|
||||
|
||||
|
||||
|
||||
- type: input
|
||||
id: note-reader-version
|
||||
attributes:
|
||||
label: note-reader plugin version
|
||||
description: Which note-reader version are you using?
|
||||
placeholder: "1.0.0"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: other-plugins-disabled
|
||||
attributes:
|
||||
label: Plugin conflict check
|
||||
description: This helps us see if the problem is caused by an interaction with another plugin.
|
||||
options:
|
||||
- label: I tried with all other community plugins disabled, and the issue still occurs.
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: possible-solution
|
||||
attributes:
|
||||
label: Possible solution (optional)
|
||||
description: |
|
||||
Optional: If you have any ideas about what might be causing the bug or how to fix it, please share them here.
|
||||
65
.github/ISSUE_TEMPLATE/feature-request.yaml
vendored
Normal file
65
.github/ISSUE_TEMPLATE/feature-request.yaml
vendored
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
name: Feature request
|
||||
description: Suggest a new feature or improvement for note-reader
|
||||
labels: ["type: enhancement"]
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: no-invalid-issues
|
||||
attributes:
|
||||
label: "⚠️ Verify your request is in the right place"
|
||||
description: "This repository is only for the note-reader plugin, not the Obsidian app itself."
|
||||
options:
|
||||
- label: "My request is about the note-reader plugin for Obsidian (not core Obsidian or another plugin)."
|
||||
required: true
|
||||
- label: "I am only requesting a single feature or change in this issue. I will open separate requests for unrelated ideas."
|
||||
required: true
|
||||
- label: "I believe this feature would be useful to other note-reader users, not just for my very specific personal workflow."
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: no-duplicate-issues
|
||||
attributes:
|
||||
label: "⚠️ Please check that this feature hasn’t been suggested already"
|
||||
description: "A quick search through existing feature requests helps avoid duplicates."
|
||||
options:
|
||||
- label: "I searched existing note-reader enhancement issues and did not find a similar request."
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: feature-description
|
||||
attributes:
|
||||
label: "🔖 Feature description"
|
||||
description: |
|
||||
Describe what you’re trying to accomplish or what’s difficult today.
|
||||
Focus on your goal or pain point, not the solution or UI details.
|
||||
placeholder: "When I try to..., I run into..., which makes it hard to..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: "✔️ How it should work"
|
||||
description: |
|
||||
Explain what you want to happen and why it would help your workflow.
|
||||
Focus on what the feature should do rather than how it should be implemented.
|
||||
placeholder: "In my use case, this would let me ..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: "❓ Alternatives you’ve considered"
|
||||
description: "Have you tried any workarounds or other approaches? If so, describe them here."
|
||||
placeholder: "I have considered ..."
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: "📝 Additional context"
|
||||
description: "Add any other context, examples, or screenshots that help explain your request."
|
||||
placeholder: "For example, a screenshot of your current workflow, or a short note showing where this would fit."
|
||||
validations:
|
||||
required: false
|
||||
Loading…
Reference in a new issue