From 64a35c72cab73279c339cb03f3db0467734919d5 Mon Sep 17 00:00:00 2001 From: zihluwang Date: Thu, 31 Jul 2025 14:44:33 +0800 Subject: [PATCH] docs: change to GitHub Issue Form --- .github/ISSUE_TEMPLATE/bug-report.yml | 78 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 36 ---------- .github/ISSUE_TEMPLATE/feature-request.yml | 66 ++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 36 ---------- 4 files changed, 144 insertions(+), 72 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..dc706b8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,78 @@ +name: Bug Report +description: Report a bug to help us improve the application. +title: "[Bug] " +labels: [bug] +type: bug +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: | + A clear and concise description of what the bug is. If applicable, add screenshots to help + explain your problem. + placeholder: Describe the bug you encountered... + validations: + required: true + - type: textarea + id: reproduction-steps + attributes: + label: Steps to Reproduce + description: Steps to help us reproduce the behaviour. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected-behaviour + attributes: + label: Expected Behaviour + description: A clear and concise description of what you expected to happen. + placeholder: Describe what you expected to happen... + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating System (OS) + description: Your operating system. + options: + - Windows + - macOS + - Linux + validations: + required: true + - type: input + id: application-version + attributes: + label: Application Version + description: The version of the Application you are using. + placeholder: e.g., x.y.z + validations: + required: true + - type: input + id: java-version + attributes: + label: Java Version + description: | + The Java Development Kit (JDK) version used. + placeholder: | + eg. Amazon Corretto x.y.z, Microsoft Open JDK x.y.z + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional Context (Optional) + description: | + Add any other context about the problem here, such as logs, specific scenarios, + or workarounds. + placeholder: Any other relevant information... \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 6f36475..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '[Bug]' -labels: bug -type: bug - ---- - -## Describe the bug - -A clear and concise description of what the bug is. - -## To Reproduce - -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -## Expected behaviour - -A clear and concise description of what you expected to happen. - -## Screenshots (Optional) - -If applicable, add screenshots to help explain your problem. - -## Developing Environment: -- **OS:** \[e.g. Windows, macOS, Linux] -- **Onixbyte Toolbox Version:** \[e.g. x.y.z] -- **Java Version:** \[e.g. Amazon Corretto 17, Oracle 17, Azul Zulu 17, Microsoft Build of OpenJDK 17] - -## Additional context (Optional) -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..aab1e36 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,66 @@ +name: Feature Request +description: Suggest an idea or new feature to enhance the Calendar Toolbox. +title: "[Feature Request] " +labels: ["feature request"] +type: feature +body: + - type: markdown + attributes: + value: | + Thanks for considering a new feature for Calendar Toolbox! Please provide as much detail as possible. + - type: textarea + id: summary + attributes: + label: Summary + description: A concise summary of the feature you'd like to see added. + placeholder: Briefly describe your feature idea here. + validations: + required: true + - type: textarea + id: why-needed + attributes: + label: Why is this needed? + description: | + Explain the problem you’re facing or what could be improved by adding this feature. How + would it make development with the Calendar Toolbox easier or better? + placeholder: Describe the problem or improvement this feature addresses. + validations: + required: true + - type: textarea + id: idea_description + attributes: + label: What's your idea? + description: | + Describe how you imagine this feature working within the class library. Feel free to share + any technical details, examples, or use cases. + placeholder: Provide details on how the feature would function. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: | + Have you tried any alternatives or workarounds? If so, what are they and why don’t they + fully meet your needs? + placeholder: List any alternatives or workarounds you've considered. + validations: + required: false + - type: input + id: target-version + attributes: + label: Target Version (Optional) + description: If you have a preferred release version for this feature, please mention it here. + placeholder: e.g., v1.2.0 or Next Minor Release + validations: + required: false + - type: textarea + id: other-info + attributes: + label: Any other info (Optional) + description: | + Anything else you think might help us understand your request better—like links, + related issues, or thoughts. + placeholder: Add any additional relevant information here. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index c2d99f4..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[Feature Request]" -labels: feature request -type: feature - ---- - -## Summary - -A short summary of the feature you'd like to see added to OnixByte Toolbox. - -## Why is this needed? - -Explain the problem you’re facing or what could be improved by adding this feature. How would it make development with the OnixByte Toolbox easier or better? - -## What’s your idea? - -Describe how you imagine this feature working within the class library. Feel free to share any technical details, examples, or use cases. - -## Alternatives - -Have you tried any alternatives or workarounds? If so, what are they and why don’t they fully meet your needs? - -## Target version (optional) - -If you have a preferred release version for this feature, please mention it here. - -## Any other info - -Anything else you think might help us understand your request better—like links, related issues, or thoughts. - ---- - -Thanks for helping us improve OnixByte Toolbox! Looking forward to your ideas.