mirror of
https://github.com/gin-gonic/gin.git
synced 2025-10-12 11:02:13 +08:00
docs: revamp GitHub contribution and support templates (#4364)
- Replace the old issue template with new, structured YAML templates for bug reports and feature requests - Add a configuration file that directs users to relevant documentation and support links - Update the pull request template to use a checklist format and clarify documentation requirements Signed-off-by: appleboy <appleboy.tw@gmail.com>
This commit is contained in:
parent
1bbbec0baf
commit
7925414704
49
.github/ISSUE_TEMPLATE.md
vendored
49
.github/ISSUE_TEMPLATE.md
vendored
@ -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
|
|
||||||
|
|
||||||
<!-- Description of a problem -->
|
|
||||||
|
|
||||||
## How to reproduce
|
|
||||||
|
|
||||||
<!-- The smallest possible code example to show the problem that can be compiled, like -->
|
|
||||||
```
|
|
||||||
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
|
|
||||||
|
|
||||||
<!-- Your expectation result of 'curl' command, like -->
|
|
||||||
```
|
|
||||||
$ curl http://localhost:9000/hello/world
|
|
||||||
Hello world
|
|
||||||
```
|
|
||||||
|
|
||||||
## Actual result
|
|
||||||
|
|
||||||
<!-- Actual result showing the problem -->
|
|
||||||
```
|
|
||||||
$ curl -i http://localhost:9000/hello/world
|
|
||||||
<YOUR RESULT>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Environment
|
|
||||||
|
|
||||||
- go version:
|
|
||||||
- gin version (or commit ref):
|
|
||||||
- operating system:
|
|
60
.github/ISSUE_TEMPLATE/bug-report.yaml
vendored
Normal file
60
.github/ISSUE_TEMPLATE/bug-report.yaml
vendored
Normal file
@ -0,0 +1,60 @@
|
|||||||
|
name: Bug Report
|
||||||
|
description: Found something you weren't expecting? Report it here!
|
||||||
|
labels: ["type/bug"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
NOTE: If your issue is a security concern, please send an email to appleboy.tw@gmail.com instead of opening a public issue.
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
1. Please speak English, this is the language all maintainers can speak and write.
|
||||||
|
2. Please ask questions problems on our Discussions Forum (https://github.com/gin-gonic/gin/discussions).
|
||||||
|
3. Make sure you are using the latest release and
|
||||||
|
take a moment to check that your issue hasn't been reported before.
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: |
|
||||||
|
Please provide a description of your issue here, with a URL if you were able to reproduce the issue (see below)
|
||||||
|
- type: input
|
||||||
|
id: gin-ver
|
||||||
|
attributes:
|
||||||
|
label: Gin Version
|
||||||
|
description: Gin version (or commit reference) of your instance
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: dropdown
|
||||||
|
id: can-reproduce
|
||||||
|
attributes:
|
||||||
|
label: Can you reproduce the bug?
|
||||||
|
description: |
|
||||||
|
If so, please write the steps to reproduce the bug.
|
||||||
|
options:
|
||||||
|
- "Yes"
|
||||||
|
- "No"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
It's really important to provide pertinent logs
|
||||||
|
Please read https://docs.gitea.com/administration/logging-config#collecting-logs-for-help
|
||||||
|
In addition, if your problem relates to git commands set `RUN_MODE=dev` at the top of app.ini
|
||||||
|
- type: textarea
|
||||||
|
id: source-code
|
||||||
|
attributes:
|
||||||
|
label: Source Code
|
||||||
|
description: If this issue involves source code, please provide a minimal reproducible example
|
||||||
|
- type: input
|
||||||
|
id: go-ver
|
||||||
|
attributes:
|
||||||
|
label: Go Version
|
||||||
|
description: The version of Go running on the server
|
||||||
|
- type: input
|
||||||
|
id: os-ver
|
||||||
|
attributes:
|
||||||
|
label: Operating System
|
||||||
|
description: The operating system you are using to run Gin
|
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Go.dev API Documentation
|
||||||
|
url: https://pkg.go.dev/github.com/gin-gonic/gin
|
||||||
|
about: Comprehensive API documentation for Gin.
|
||||||
|
- name: Gin User Guides
|
||||||
|
url: https://gin-gonic.com/
|
||||||
|
about: In-depth user guides and tutorials for using Gin.
|
||||||
|
- name: Discussions Forum
|
||||||
|
url: https://github.com/gin-gonic/gin/discussions
|
||||||
|
about: Questions and configuration or deployment problems can also be discussed.
|
18
.github/ISSUE_TEMPLATE/feature-request.yaml
vendored
Normal file
18
.github/ISSUE_TEMPLATE/feature-request.yaml
vendored
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
name: Feature Request
|
||||||
|
description: Got an idea for a feature that Gin doesn't have currently? Submit your idea here!
|
||||||
|
labels: ["type/proposal"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
1. Please speak English, this is the language all maintainers can speak and write.
|
||||||
|
2. Please ask questions problems on our Discussions Forum (https://github.com/gin-gonic/gin/discussions).
|
||||||
|
3. Please take a moment to check that your feature hasn't already been suggested.
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Feature Description
|
||||||
|
placeholder: |
|
||||||
|
I think it would be great if Gin had...
|
||||||
|
validations:
|
||||||
|
required: true
|
15
.github/PULL_REQUEST_TEMPLATE.md
vendored
15
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,7 +1,10 @@
|
|||||||
- With pull requests:
|
# Pull Request Checklist
|
||||||
- Open your pull request against `master`
|
|
||||||
- Your pull request should have no more than two commits, if not you should squash them.
|
|
||||||
- It should pass all tests in the available continuous integration systems such as GitHub Actions.
|
|
||||||
- You should add/modify tests to cover your proposed code changes.
|
|
||||||
- If your pull request contains a new feature, please document it on the README.
|
|
||||||
|
|
||||||
|
Please ensure your pull request meets the following requirements:
|
||||||
|
|
||||||
|
- [ ] Open your pull request against the `master` branch.
|
||||||
|
- [ ] All tests pass in available continuous integration systems (e.g., GitHub Actions).
|
||||||
|
- [ ] Tests are added or modified as needed to cover code changes.
|
||||||
|
- [ ] If the pull request introduces a new feature, the feature is documented in the `docs/doc.md`.
|
||||||
|
|
||||||
|
Thank you for contributing!
|
||||||
|
Loading…
x
Reference in New Issue
Block a user