From 6eb881bffed28af2c0493c34273bec5bc4b24473 Mon Sep 17 00:00:00 2001 From: Mario Pietsch Date: Sun, 4 Jan 2026 14:08:40 +0100 Subject: [PATCH] New issue and bug report templates (#9512) * New issue and bug report templates * Change bug_report to .md file * update bug report text * Move To Reproduce up next to Problem Description * Fix typo --- .github/ISSUE_TEMPLATE/bug_report.md | 62 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 68 ----------------------- .github/ISSUE_TEMPLATE/feature_request.md | 11 +++- 3 files changed, 70 insertions(+), 71 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..b2b0964b2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,62 @@ +--- +name: Bug report +description: Create a report to help us improve TiddlyWiki 5 +title: "[Report] " +type: report + +--- + + + + +**Problem Description** + + + +**To Reproduce** + +Steps to reproduce the behavior: + +1. At https://tiddlywiki.com +2. Click on ... +3. Scroll down to ... +4. See ... + + +**Expected behavior** + +As a user, + +I would expect ... + + +**TiddlyWiki Configuration** + + +- Report created with: [Wiki Information](https://tiddlywiki.com/#%24%3A%2Fcore%2Fui%2FControlPanel%2FWikiInformation) + + + + + +- Version: +- Saving mechanism: +- Plugins installed: + + +**Desktop** + + +- OS: +- Browser: + +**Smartphone** + + +- Device: +- OS: +- Browser: + + +**Additional context** + diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index e0334e007..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,68 +0,0 @@ -name: Bug report -description: Create a report to help us improve TiddlyWiki 5 -title: "[BUG] " -type: bug -body: - - type: textarea - id: Describe - attributes: - label: Describe the bug - description: A clear and concise description of what the bug is. - validations: - required: true - - type: textarea - id: Expected - attributes: - label: Expected behavior - description: A clear and concise description of what you expected to happen. - validations: - required: false - - type: textarea - id: Reproduce - 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: false - - type: textarea - id: Screenshots - attributes: - label: Screenshots - description: If applicable, add screenshots to help explain your problem. - placeholder: Drag image here to upload screenshot! - validations: - required: false - - type: textarea - id: Configuration - attributes: - label: TiddlyWiki Configuration - description: please complete the following information - placeholder: | - - Version [e.g. v5.1.24] - - Saving mechanism [e.g. Node.js, TiddlyDesktop, TiddlyHost etc] - - Plugins installed [e.g. Freelinks, TiddlyMap] - - ### Desktop (please complete the following information): - - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - - ### Smartphone (please complete the following information): - - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - validations: - required: true - - type: textarea - id: Context - attributes: - label: Additional context - description: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 59f3dfcb2..c6a7f8022 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,18 +4,23 @@ about: Suggest an idea for TiddlyWiki 5 title: "[IDEA]" labels: '' assignees: '' -type: feature +type: idea --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**Is your idea related to a problem? Please describe.** + +A clear and concise description of what the problem is. Eg: +As a user, I would like [...] **Describe the solution you'd like** + A clear and concise description of what you want to happen. **Describe alternatives you've considered** + A clear and concise description of any alternative solutions or features you've considered. **Additional context** + Add any other context or screenshots about the feature request here.