From 05e6982c4b10b1c24263bd5b403a160f15fcae1d Mon Sep 17 00:00:00 2001 From: siujamo Date: Wed, 16 Jul 2025 17:43:09 +0800 Subject: [PATCH] docs: upgrade issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++------------- .github/ISSUE_TEMPLATE/feature_request.md | 36 ++++++++++++++++------- 2 files changed, 40 insertions(+), 31 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c223ec4..6f36475 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,43 +1,36 @@ --- name: Bug report about: Create a report to help us improve -title: "[BUG]" +title: '[Bug]' labels: bug -assignees: zihluwang, theodorehills +type: bug --- -**Which module creates this bug** -- [ ] `devkit-core` -- [ ] `devkit-utils` -- [ ] `guid` -- [ ] `webcal` -- [ ] `simple-jwt-facade` -- [ ] `simple-jwt-authzero` -- [ ] `simple-jwt-jjwt` -- [ ] `simple-jwt-spring-boot-starter` +## Describe the bug -**Describe the bug** A clear and concise description of what the bug is. -**To Reproduce** +## To Reproduce + Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** +## Expected behaviour + A clear and concise description of what you expected to happen. -**Screenshots** +## Screenshots (Optional) + If applicable, add screenshots to help explain your problem. -**Developing Environment:** - - OS: [e.g. Windows, macOS, Linux, Ubuntu] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - - Java Version: [e.g. Amazon Corretto 17, Oracle 17, Azul Zulu 17, Microsoft Build of OpenJDK 17] +## 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** +## Additional context (Optional) 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 be09f3f..c2d99f4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,36 @@ --- name: Feature request about: Suggest an idea for this project -title: "[FEATURE REQUEST]" +title: "[Feature Request]" labels: feature request -assignees: zihluwang, theodorehills +type: feature --- -**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 [...] +## Summary -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +A short summary of the feature you'd like to see added to OnixByte Toolbox. -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +## Why is this needed? -**Additional context** -Add any other context or screenshots about the feature request here. +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.