diff --git a/.github/ISSUE_TEMPLATE/---bug.md b/.github/ISSUE_TEMPLATE/---bug.md deleted file mode 100644 index a250292311..0000000000 --- a/.github/ISSUE_TEMPLATE/---bug.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: "\U0001F41B Bug" -about: Create a report to help us improve -title: "\U0001F41B " -labels: 'Type: Bug' -assignees: '' - ---- - -**Fiber version** - -**Issue description** - -**Code snippet** - -```go -package main - -import "github.com/gofiber/fiber/v2" - -func main() { - app := fiber.New() - - // Steps to reproduce - - log.Fatal(app.Listen(":3000")) -} -``` diff --git a/.github/ISSUE_TEMPLATE/---feature.md b/.github/ISSUE_TEMPLATE/---feature.md deleted file mode 100644 index c3baf503a2..0000000000 --- a/.github/ISSUE_TEMPLATE/---feature.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: "\U0001F680 Feature" -about: Suggest an idea for this project -title: "\U0001F680 " -labels: 'Type: Feature' -assignees: '' - ---- - -**Is your feature request related to a problem?** - -**Describe the solution you'd like** - -**Describe alternatives you've considered** - -**Additional context** diff --git a/.github/ISSUE_TEMPLATE/---question.md b/.github/ISSUE_TEMPLATE/---question.md deleted file mode 100644 index 68912c2b38..0000000000 --- a/.github/ISSUE_TEMPLATE/---question.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: "\U0001F917 Question" -about: Ask a question so we can help -title: "\U0001F917 " -labels: 'Type: Question' -assignees: '' - ---- - -**Question description** - -**Code snippet** _Optional_ - -```go -package main - -import "github.com/gofiber/fiber/v2" - -func main() { - app := fiber.New() - // .. -} -``` diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 0000000000..c4a902a86f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,85 @@ +name: "\U0001F41B Bug Report" +title: "\U0001F41B [Bug]: " +description: Create a bug report to help us fix it. +labels: ["☢️ Bug"] + +body: + - type: markdown + id: notice + attributes: + value: | + ### Notice + **This repository is not related to external or third-part Fiber modules. If you have a problem with them, open an issue under their repos. If you think the problem is related to Fiber, open the issue here.** + - Dont't forget you can ask your questions on our [Discord server](https://gofiber.io/discord). + - If you think Fiber doesn't have a nice feature that you think, open the issue with **✏️ Feature Request** template. + - Write your issue with clear and understandable English. + - type: textarea + id: description + attributes: + label: "Bug Description" + description: "A clear and detailed description of what the bug is." + placeholder: "Explain your problem as clear and detailed." + validations: + required: true + - type: textarea + id: how-to-reproduce + attributes: + label: How to Reproduce + description: "Steps to reproduce the behavior and what should be observed in the end." + placeholder: "Tell us step by step how we can replicate your problem and what we should see in the end." + value: | + Steps to reproduce the behavior: + 1. Go to '....' + 2. Click on '....' + 3. Do '....' + 4. See '....' + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: "A clear and detailed description of what you think should happens." + placeholder: "Tell us what Fiber should normally do." + validations: + required: true + - type: input + id: version + attributes: + label: "Fiber Version" + description: "Some bugs may be fixed in future Fiber releases, so we have to know your Fiber version." + placeholder: "Write your Fiber version. (v2.33.0, v2.34.1...)" + validations: + required: true + - type: textarea + id: snippet + attributes: + label: "Code Snippet (optional)" + description: "For some issues, we need to know some parts of your code." + placeholder: "Share a code you think related to the issue." + render: go + value: | + package main + + import "github.com/gofiber/fiber/v2" + import "log" + + func main() { + app := fiber.New() + + // Steps to reproduce + + log.Fatal(app.Listen(":3000")) + } + - type: checkboxes + id: terms + attributes: + label: "Checklist:" + description: "By submitting this issue, you confirm that:" + options: + - label: "I agree to follow Fiber's [Code of Conduct](../CODE_OF_CONDUCT.md)." + required: true + - label: "I have checked for existing issues that describe my problem prior to opening this one." + required: true + - label: "I understand that improperly formatted bug reports may be closed without explanation." + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 0000000000..0e63adc060 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,60 @@ +name: "\U0001F680 Feature Request" +title: "\U0001F680 [Feature]: " +description: Suggest an idea to improve this project. +labels: ["✏️ Feature"] + +body: + - type: markdown + id: notice + attributes: + value: | + ### Notice + - Dont't forget you can ask your questions on our [Discord server](https://gofiber.io/discord). + - If you think this is just a bug, open the issue with **☢️ Bug Report** template. + - Write your issue with clear and understandable English. + - type: textarea + id: description + attributes: + label: "Feature Description" + description: "A clear and detailed description of the feature we need to do." + placeholder: "Explain your feature as clear and detailed." + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: "Additional Context (optional)" + description: "If you have something else to describe, write them here." + placeholder: "Write here what you can describe differently." + - type: textarea + id: snippet + attributes: + label: "Code Snippet (optional)" + description: "Code snippet may be really helpful to describe some features." + placeholder: "Share a code to explain the feature better." + render: go + value: | + package main + + import "github.com/gofiber/fiber/v2" + import "log" + + func main() { + app := fiber.New() + + // An example to describe the feature + + log.Fatal(app.Listen(":3000")) + } + - type: checkboxes + id: terms + attributes: + label: "Checklist:" + description: "By submitting this issue, you confirm that:" + options: + - label: "I agree to follow Fiber's [Code of Conduct](../CODE_OF_CONDUCT.md)." + required: true + - label: "I have checked for existing issues that describe my suggestion prior to opening this one." + required: true + - label: "I understand that improperly formatted feature requests may be closed without explanation." + required: true diff --git a/.github/ISSUE_TEMPLATE/question.yaml b/.github/ISSUE_TEMPLATE/question.yaml new file mode 100644 index 0000000000..b1cdfa694c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yaml @@ -0,0 +1,55 @@ +name: "🤔 Question" +title: "\U0001F917 [Question]: " +description: Ask a question so we can help you easily. +labels: ["🤔 Question"] + +body: + - type: markdown + id: notice + attributes: + value: | + ### Notice + - Dont't forget you can ask your questions on our [Discord server](https://gofiber.io/discord). + - If you think this is just a bug, open the issue with **☢️ Bug Report** template. + - If you think Fiber doesn't have a nice feature that you think, open the issue with **✏️ Feature Request** template. + - Write your issue with clear and understandable English. + - type: textarea + id: description + attributes: + label: "Question Description" + description: "A clear and detailed description of the question." + placeholder: "Explain your question as clear and detailed." + validations: + required: true + - type: textarea + id: snippet + attributes: + label: "Code Snippet (optional)" + description: "Code snippet may be really helpful to describe some features." + placeholder: "Share a code to explain the feature better." + render: go + value: | + package main + + import "github.com/gofiber/fiber/v2" + import "log" + + func main() { + app := fiber.New() + + // An example to describe the question + + log.Fatal(app.Listen(":3000")) + } + - type: checkboxes + id: terms + attributes: + label: "Checklist:" + description: "By submitting this issue, you confirm that:" + options: + - label: "I agree to follow Fiber's [Code of Conduct](../CODE_OF_CONDUCT.md)." + required: true + - label: "I have checked for existing issues that describe my questions prior to opening this one." + required: true + - label: "I understand that improperly formatted questions may be closed without explanation." + required: true