diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 864787ca..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,49 +0,0 @@ -- With issues: - - Use the search tool before opening a new issue. - - Please provide source code and commit sha if you found a bug. - - Review existing issues and provide feedback or react to them. - -## Description - - - -## How to reproduce - - -``` -package main - -import ( - "github.com/gin-gonic/gin" -) - -func main() { - g := gin.Default() - g.GET("/hello/:name", func(c *gin.Context) { - c.String(200, "Hello %s", c.Param("name")) - }) - g.Run(":9000") -} -``` - -## Expectations - - -``` -$ curl http://localhost:9000/hello/world -Hello world -``` - -## Actual result - - -``` -$ curl -i http://localhost:9000/hello/world - -``` - -## Environment - -- go version: -- gin version (or commit ref): -- operating system: diff --git a/.github/ISSUE_TEMPLATE/00-bug.yml b/.github/ISSUE_TEMPLATE/00-bug.yml new file mode 100644 index 00000000..6006c6ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/00-bug.yml @@ -0,0 +1,67 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Bugs +description: I found a bug +title: "issue title" +labels: + - bug + +body: + - type: markdown + attributes: + value: | + Thanks for helping us improve! 🙏 Please answer these questions and provide as much information as possible about your problem. + + - type: input + id: go-version + attributes: + label: Go version + description: | + What version of Go are you using (`go version`)? + placeholder: ex. go version go1.20.7 darwin/arm64 + validations: + required: true + + - type: input + id: gin-version + attributes: + label: Gin version + description: | + What version(or commit ref) of Gin are you using? + placeholder: ex. 1.9.1 + validations: + required: true + + - type: dropdown + id: is-reproducible + attributes: + label: Can this bug be reproduced with the latest release? + options: + - Option Yes + - Option No + validations: + required: true + + - type: textarea + id: what-did-you-do + attributes: + label: "What did you do?" + description: "If possible, provide a recipe for reproducing the error. A complete runnable program is good. A link on [go.dev/play](https://go.dev/play) is best." + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: "What did you see happen?" + description: Command invocations and their associated output, functions with their arguments and return results, full stacktraces for panics (upload a file if it is very long), etc. Prefer copying text output over using screenshots. + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: "What did you expect to see?" + description: Why is the current output incorrect, and any additional context we may need to understand the issue. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/01-enhance.yml b/.github/ISSUE_TEMPLATE/01-enhance.yml new file mode 100644 index 00000000..1eb568d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-enhance.yml @@ -0,0 +1,28 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Enhancements +description: Enhance an idea for this project +title: "issue title" +labels: + - enhancement + +body: + - type: markdown + attributes: + value: | + Thanks for helping us improve! 🙏 Please answer these questions and provide as much information as possible about your problem. + + - type: textarea + id: description + attributes: + label: "Description" + description: "Please describe your idea in detail." + validations: + required: true + + - type: textarea + id: additional + attributes: + label: "Additional" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/02-feature.yml b/.github/ISSUE_TEMPLATE/02-feature.yml new file mode 100644 index 00000000..db65280c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature.yml @@ -0,0 +1,44 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Features +description: Suggest an idea for this project +title: "issue title" +labels: + - feature + +body: + - type: markdown + attributes: + value: | + Thanks for helping us improve! 🙏 Please answer these questions and provide as much information as possible about your problem. + + - type: dropdown + id: is-problem + attributes: + label: Is your feature request related to a problem? + options: + - Option Yes + - Option No + validations: + required: true + + - type: textarea + id: description-solution + attributes: + label: "Describe the solution you'd like" + validations: + required: true + + - type: textarea + id: description-considered + attributes: + label: "Describe alternatives you've considered" + validations: + required: true + + - type: textarea + id: additional + attributes: + label: "Additional" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/03-question.yml b/.github/ISSUE_TEMPLATE/03-question.yml new file mode 100644 index 00000000..3352101d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-question.yml @@ -0,0 +1,22 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Questions +description: I want to ask a question +title: "issue title" +labels: + - question + +body: + - type: markdown + attributes: + value: | + Use the search tool before opening a new issue. + Please read the document carefully. + + - type: textarea + id: ask + attributes: + label: "What do you want to ask?" + description: "Please describe the details of your questions." + validations: + required: true