Skip to content

Commit b6818c2

Browse files
efectnefectn
authored
📝 docs: new issue templates (#1945)
* 📝 docs: new issue templates * 📝 docs: new issue templates * 📝 docs: new issue templates * 📝 docs: new issue templates * 📝 docs: new issue templates
1 parent a337e95 commit b6818c2

6 files changed

Lines changed: 200 additions & 67 deletions

File tree

‎.github/ISSUE_TEMPLATE/---bug.md‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/---feature.md‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/---question.md‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug-report.yaml‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: "\U0001F41B Bug Report"
2+
title: "\U0001F41B [Bug]: "
3+
description: Create a bug report to help us fix it.
4+
labels: ["☢️ Bug"]
5+
6+
body:
7+
- type: markdown
8+
id: notice
9+
attributes:
10+
value: |
11+
### Notice
12+
**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.**
13+
- Dont't forget you can ask your questions on our [Discord server](https://gofiber.io/discord).
14+
- If you think Fiber doesn't have a nice feature that you think, open the issue with **✏️ Feature Request** template.
15+
- Write your issue with clear and understandable English.
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: "Bug Description"
20+
description: "A clear and detailed description of what the bug is."
21+
placeholder: "Explain your problem as clear and detailed."
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: how-to-reproduce
26+
attributes:
27+
label: How to Reproduce
28+
description: "Steps to reproduce the behavior and what should be observed in the end."
29+
placeholder: "Tell us step by step how we can replicate your problem and what we should see in the end."
30+
value: |
31+
Steps to reproduce the behavior:
32+
1. Go to '....'
33+
2. Click on '....'
34+
3. Do '....'
35+
4. See '....'
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: expected-behavior
40+
attributes:
41+
label: Expected Behavior
42+
description: "A clear and detailed description of what you think should happens."
43+
placeholder: "Tell us what Fiber should normally do."
44+
validations:
45+
required: true
46+
- type: input
47+
id: version
48+
attributes:
49+
label: "Fiber Version"
50+
description: "Some bugs may be fixed in future Fiber releases, so we have to know your Fiber version."
51+
placeholder: "Write your Fiber version. (v2.33.0, v2.34.1...)"
52+
validations:
53+
required: true
54+
- type: textarea
55+
id: snippet
56+
attributes:
57+
label: "Code Snippet (optional)"
58+
description: "For some issues, we need to know some parts of your code."
59+
placeholder: "Share a code you think related to the issue."
60+
render: go
61+
value: |
62+
package main
63+
64+
import "github.com/gofiber/fiber/v2"
65+
import "log"
66+
67+
func main() {
68+
app := fiber.New()
69+
70+
// Steps to reproduce
71+
72+
log.Fatal(app.Listen(":3000"))
73+
}
74+
- type: checkboxes
75+
id: terms
76+
attributes:
77+
label: "Checklist:"
78+
description: "By submitting this issue, you confirm that:"
79+
options:
80+
- label: "I agree to follow Fiber's [Code of Conduct](../CODE_OF_CONDUCT.md)."
81+
required: true
82+
- label: "I have checked for existing issues that describe my problem prior to opening this one."
83+
required: true
84+
- label: "I understand that improperly formatted bug reports may be closed without explanation."
85+
required: true

‎.github/ISSUE_TEMPLATE/feature-request.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: "\U0001F680 Feature Request"
2+
title: "\U0001F680 [Feature]: "
3+
description: Suggest an idea to improve this project.
4+
labels: ["✏️ Feature"]
5+
6+
body:
7+
- type: markdown
8+
id: notice
9+
attributes:
10+
value: |
11+
### Notice
12+
- Dont't forget you can ask your questions on our [Discord server](https://gofiber.io/discord).
13+
- If you think this is just a bug, open the issue with **☢️ Bug Report** template.
14+
- Write your issue with clear and understandable English.
15+
- type: textarea
16+
id: description
17+
attributes:
18+
label: "Feature Description"
19+
description: "A clear and detailed description of the feature we need to do."
20+
placeholder: "Explain your feature as clear and detailed."
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: additional-context
25+
attributes:
26+
label: "Additional Context (optional)"
27+
description: "If you have something else to describe, write them here."
28+
placeholder: "Write here what you can describe differently."
29+
- type: textarea
30+
id: snippet
31+
attributes:
32+
label: "Code Snippet (optional)"
33+
description: "Code snippet may be really helpful to describe some features."
34+
placeholder: "Share a code to explain the feature better."
35+
render: go
36+
value: |
37+
package main
38+
39+
import "github.com/gofiber/fiber/v2"
40+
import "log"
41+
42+
func main() {
43+
app := fiber.New()
44+
45+
// An example to describe the feature
46+
47+
log.Fatal(app.Listen(":3000"))
48+
}
49+
- type: checkboxes
50+
id: terms
51+
attributes:
52+
label: "Checklist:"
53+
description: "By submitting this issue, you confirm that:"
54+
options:
55+
- label: "I agree to follow Fiber's [Code of Conduct](../CODE_OF_CONDUCT.md)."
56+
required: true
57+
- label: "I have checked for existing issues that describe my suggestion prior to opening this one."
58+
required: true
59+
- label: "I understand that improperly formatted feature requests may be closed without explanation."
60+
required: true

‎.github/ISSUE_TEMPLATE/question.yaml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: "🤔 Question"
2+
title: "\U0001F917 [Question]: "
3+
description: Ask a question so we can help you easily.
4+
labels: ["🤔 Question"]
5+
6+
body:
7+
- type: markdown
8+
id: notice
9+
attributes:
10+
value: |
11+
### Notice
12+
- Dont't forget you can ask your questions on our [Discord server](https://gofiber.io/discord).
13+
- If you think this is just a bug, open the issue with **☢️ Bug Report** template.
14+
- If you think Fiber doesn't have a nice feature that you think, open the issue with **✏️ Feature Request** template.
15+
- Write your issue with clear and understandable English.
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: "Question Description"
20+
description: "A clear and detailed description of the question."
21+
placeholder: "Explain your question as clear and detailed."
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: snippet
26+
attributes:
27+
label: "Code Snippet (optional)"
28+
description: "Code snippet may be really helpful to describe some features."
29+
placeholder: "Share a code to explain the feature better."
30+
render: go
31+
value: |
32+
package main
33+
34+
import "github.com/gofiber/fiber/v2"
35+
import "log"
36+
37+
func main() {
38+
app := fiber.New()
39+
40+
// An example to describe the question
41+
42+
log.Fatal(app.Listen(":3000"))
43+
}
44+
- type: checkboxes
45+
id: terms
46+
attributes:
47+
label: "Checklist:"
48+
description: "By submitting this issue, you confirm that:"
49+
options:
50+
- label: "I agree to follow Fiber's [Code of Conduct](../CODE_OF_CONDUCT.md)."
51+
required: true
52+
- label: "I have checked for existing issues that describe my questions prior to opening this one."
53+
required: true
54+
- label: "I understand that improperly formatted questions may be closed without explanation."
55+
required: true

0 commit comments

Comments
 (0)