Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
valentine195 committed May 8, 2023
2 parents 4599fc6 + 07dcf91 commit 908b3c8
Show file tree
Hide file tree
Showing 11 changed files with 518 additions and 169 deletions.
108 changes: 108 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
name: Bug Report
description: File a bug report
labels: ["type: bug"]
body:
- type: markdown
attributes:
value: |
## Before you begin
Make sure to use the latest version of the plugin.
If you face any issues after installing, updating, or reloading the plugin, try restarting Obsidian before reporting the bug.
Also, please make sure you **read and understand the **[guide for good bug reports](https://plugins.javalent.com/support/report-bug)**.
- type: checkboxes
id: duplicate-issues
attributes:
label: "Check for existing bug reports before submitting."
description: "Use Label filters to refine your search. Check both open and closed issues to see if your issue has already been reported."
options:
- label: "I searched for existing Bug Reports and found no similar reports."
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What *should have** happened?
validations:
required: true

- type: textarea
id: what-happened
attributes:
label: Current behaviour
description: |
How did the issue manifest itself in reality? Including screenshots would be helpful.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Reproduction
description: |
Please provide us with the exact steps to reproduce the issue.
The more detail you provide, the easier it will be for us to narrow down and fix the bug.
Please ensure that you paste in codeblocks and/or queries as text, rather than screenshots.
Format your pasted text as described in Give us Text to copy.
We will not accept bug reports that require anyone to re-type text from screenshots or descriptive text.
Please note that if you're a Mac user, a Safari bug might strip newlines from your text.
placeholder: |
Example of the level of detail needed to reproduce any bugs efficiently and reliably.
Without it, your issue may get worked on last.
1. Launch Obsidian Sandbox via the `Open Sandbox Vault` command.
2. Install the Fantasy Statblocks plugin.
3. Change the global filter to...
4. Create a new note called `Demo problem`.
5. Installed Dataview and Statblocks stopped working.
6. Switch to Reading mode.
7. etc
(Mac users: a Safari bug strips newlines from this text.)
validations:
required: true

- type: checkboxes
id: operating-systems
attributes:
label: Which Operating Systems are you using?
description: You may select more than one.
options:
- label: Android
- label: iPhone/iPad
- label: Linux
- label: macOS
- label: Windows

- type: input
id: obsidian-version
attributes:
label: Obsidian Version Check
description: Which Obsidian Version and Installer Version are you using?
placeholder: 1.28.7 and 1.2.7
validations:
required: true

- type: input
id: plugin-version
attributes:
label: Plugin Version
description: Which plugin version are you using?
placeholder: 3.6.3
validations:
required: true

- type: checkboxes
id: other-plugins-disabled
attributes:
label: Confirmation
description: Please confirm that you have completed the following steps before submitting your issue.
options:
- label: I have disabled all other plugins and the issue still persists.
required: false

- type: textarea
id: possible-solution
attributes:
label: Possible solution
description: |
(Optional) If you have any ideas, please suggest a fix or a possible reason for the bug.
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/code-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Code Report
description: Report an Update to Code
labels: ["type: Code"]
body:
- type: markdown
attributes:
value: |
## About this form
This form is only for tracking developer-focussed actions, such as
refactoring, dependency updates and similar.
Rarely, these might be used to gauge user data.
- type: textarea
id: scope
attributes:
label: Scope
description: What is the scope of the change and why is it needed?
validations:
required: true

- type: textarea
id: discovery
attributes:
label: Discovery
description: |
What will be changed?.
validations:
required: true

- type: textarea
id: validation
attributes:
label: Validate
description: |
What was your environment you tested these changes in?
Do any new dependencies need to be added?
Any other pertinent information?
validations:
required: true
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/code_report.md

This file was deleted.

51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-update.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Documentation Report
description: Request Documentation Update
labels: [ "type: Documentation" ]
body:
- type: checkboxes
id: investigation
attributes:
label: "What are we changing or adding?"
description: "Please pick where you are requesting the documentation to change."
options:
- label: "Repository"
required: false
- label: "[Publish Documentation](https://plugins.javalent.com/)"
required: false


- type: textarea
id: location
validations:
required: true
attributes:
label: "Location"
description: "In what section are we changing?"
placeholder: "We're changing this in the pinned threads."

- type: textarea
id: issue
validations:
required: true
attributes:
label: "The issue is..."
description: "Describe what is the reason and motivation for this change?"
placeholder: "I do not understand this terminology that is being used here..."

- type: textarea
id: suggestions
validations:
required: true
attributes:
label: "Suggestions?"
description: "Do you have any suggestions on what wording can be changed or added?"
placeholder: "I have pondered and here is a small write-up ..."

- type: textarea
id: anything-else
validations:
required: true
attributes:
label: "Anything else?"
description: "Did we miss anything? What else do you want to add?"
placeholder: "I think the Settings Search song sucks, and the mascot should be Murder Gemmy."
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/documentation_report.md

This file was deleted.

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Feature Request
description: Request a new feature
labels: [ "type: Feature" ]
body:
- type: checkboxes
id: duplicate-issues
attributes:
label: "Please make sure this feature request hasn't been suggested before."
description: "Before submitting a feature request, please check if it has already been suggested in our Discussions or Issues pages. Use the **Label filters** to refine your search."
options:
- label: "I searched previous Issues and didn't find any similar feature requests."
required: true

- type: textarea
id: feature-description
validations:
required: true
attributes:
label: "Feature description"
description: "Please provide a clear and concise description of the feature you are requesting."
placeholder: "I would like to see ..."

- type: textarea
id: solution
validations:
required: true
attributes:
label: "Solution"
description: "Please describe your proposed solution for this feature request, and explain why it's necessary."
placeholder: "In my use case, it would be helpful to have ..."

- type: textarea
id: alternatives
validations:
required: true
attributes:
label: "Alternatives"
description: "Please provide any alternative solutions or features you've considered. Be clear and concise."
placeholder: "I have considered ..."

- type: textarea
id: additional-context
validations:
required: true
attributes:
label: "Additional Information"
description: "If you have any additional context or screenshots related to your feature request, please add them here."
placeholder: "..."
Loading

0 comments on commit 908b3c8

Please sign in to comment.