From f6870a65306a432a65ebd98767c0fe933d310b08 Mon Sep 17 00:00:00 2001 From: Rebbecca Bishop Date: Tue, 30 May 2023 11:46:04 -0500 Subject: [PATCH] Added YAML Templates --- .github/ISSUE_TEMPLATE/bug-report.yaml | 111 ++++++++++++++++++ .github/ISSUE_TEMPLATE/code-report.yml | 42 +++++++ .../ISSUE_TEMPLATE/documentation-update.yaml | 54 +++++++++ 3 files changed, 207 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/code-report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation-update.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 0000000..153b9b6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,111 @@ +name: Bug Report +description: File a bug report +labels: bug +title: "[Bug]: " +assignees: + - Valentine195 +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 Javalent 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. diff --git a/.github/ISSUE_TEMPLATE/code-report.yml b/.github/ISSUE_TEMPLATE/code-report.yml new file mode 100644 index 0000000..4c88742 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/code-report.yml @@ -0,0 +1,42 @@ +name: Code Report +description: Report an Update to Code +labels: code +title: "[Code]: " +assignees: + - Sigrunixia + - Valentine195 +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 diff --git a/.github/ISSUE_TEMPLATE/documentation-update.yaml b/.github/ISSUE_TEMPLATE/documentation-update.yaml new file mode 100644 index 0000000..4f78746 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-update.yaml @@ -0,0 +1,54 @@ +name: Documentation Report +description: Request Documentation Update +labels: documentation +title: "[Docu]: " +assignees: + - Sigrunixia +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."