mirror of
https://gitee.com/johng/gf
synced 2026-06-06 02:25:47 +08:00
other: enhance Issues and Pull Requests template (#3533)
This commit is contained in:
oldme
67
.github/ISSUE_TEMPLATE/00-bug.yml
vendored
Normal file
67
.github/ISSUE_TEMPLATE/00-bug.yml
vendored
Normal file
@ -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: GoFrame command, module, or anything else
|
||||
title: "os/gtime: 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: gf-version
|
||||
attributes:
|
||||
label: GoFrame version
|
||||
description: |
|
||||
What version of GoFrame are you using (`gf version`)?
|
||||
placeholder: ex. 2.7.0
|
||||
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
|
||||
28
.github/ISSUE_TEMPLATE/01-enhance.yml
vendored
Normal file
28
.github/ISSUE_TEMPLATE/01-enhance.yml
vendored
Normal file
@ -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: "os/gtime: 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
|
||||
44
.github/ISSUE_TEMPLATE/02-feature.yml
vendored
Normal file
44
.github/ISSUE_TEMPLATE/02-feature.yml
vendored
Normal file
@ -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: "os/gtime: 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
|
||||
16
.github/ISSUE_TEMPLATE/03-question.yml
vendored
Normal file
16
.github/ISSUE_TEMPLATE/03-question.yml
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
# 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: "os/gtime: issue title"
|
||||
labels:
|
||||
- question
|
||||
|
||||
body:
|
||||
- type: textarea
|
||||
id: ask
|
||||
attributes:
|
||||
label: "What do you want to ask?"
|
||||
description: "Please read the document carefully. 请先仔细阅读文档"
|
||||
validations:
|
||||
required: true
|
||||
41
.github/ISSUE_TEMPLATE/bug-report.md
vendored
41
.github/ISSUE_TEMPLATE/bug-report.md
vendored
@ -1,41 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!-- Please answer these questions before submitting your issue. Thanks! -->
|
||||
|
||||
<!-- 为高效处理 Bug，请您务必提供可复现该问题的最小可运行代码！否则 issue 可能会被延期处理！ -->
|
||||
<!-- 为高效处理 Bug，请您务必提供可复现该问题的最小可运行代码！否则 issue 可能会被延期处理！ -->
|
||||
<!-- 为高效处理 Bug，如请您务必提供可复现该问题的最小可运行代码！否则 issue 可能会被延期处理！ -->
|
||||
<!-- 重要的事情说三遍！ -->
|
||||
|
||||
**What version of `Go` and system type/arch are you using?**
|
||||
<!--
|
||||
Please paste the output of command `go version` from your terminal.
|
||||
What expects to see is like: `go 1.12, linux/amd64`
|
||||
-->
|
||||
|
||||
|
||||
**What version of `GoFrame` are you using?**
|
||||
<!-- You can find the GF version from your `go.mod`, or from the `version.go` in `GF` -->
|
||||
|
||||
|
||||
**Can this bug be re-produced with the latest release?**
|
||||
|
||||
|
||||
**What did you do?**
|
||||
<!--
|
||||
If possible, provide a copy of shortest codes for reproducing the error.
|
||||
A complete runnable program is best.
|
||||
-->
|
||||
|
||||
|
||||
**What did you expect to see?**
|
||||
|
||||
|
||||
**What did you see instead?**
|
||||
16
.github/ISSUE_TEMPLATE/enhancement-request.md
vendored
16
.github/ISSUE_TEMPLATE/enhancement-request.md
vendored
@ -1,16 +0,0 @@
|
||||
---
|
||||
name: Enhancement request
|
||||
about: Enhance an idea for this project
|
||||
title: ''
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Package that You wish to enhance**
|
||||
|
||||
|
||||
**Enhancement description**
|
||||
|
||||
|
||||
**Additional**
|
||||
19
.github/ISSUE_TEMPLATE/feature-request.md
vendored
19
.github/ISSUE_TEMPLATE/feature-request.md
vendored
@ -1,19 +0,0 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: feature
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
|
||||
|
||||
**Describe the solution you'd like**
|
||||
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
|
||||
|
||||
**Additional**
|
||||
11
.github/ISSUE_TEMPLATE/question.md
vendored
11
.github/ISSUE_TEMPLATE/question.md
vendored
@ -1,11 +0,0 @@
|
||||
---
|
||||
name: Question
|
||||
about: I want to ask a question
|
||||
title: ''
|
||||
labels: question
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!-- 请优先仔细阅读文档 -->
|
||||
**What do you want to ask**
|
||||
22
.github/PULL_REQUEST_TEMPLATE.MD
vendored
Normal file
22
.github/PULL_REQUEST_TEMPLATE.MD
vendored
Normal file
@ -0,0 +1,22 @@
|
||||
**Please ensure you adhere to every item in this list.**
|
||||
+ The PR title is formatted as follows: `os/gtime: fixed time zone issues`
|
||||
+ The package name goes before the colon
|
||||
+ The part after the colon uses the verb tense + phrase that completes the blank in
|
||||
+ Lowercase verb after the colon
|
||||
+ No trailing period
|
||||
+ Keep the title as short as possible. ideally under 76 characters or shorter
|
||||
+ Title not Markdown
|
||||
+ If there is a corresponding issue, add either `Fixes #1234` or `Updates #1234`
|
||||
(the latter if this is not a complete fix) to this comment
|
||||
+ Delete these instructions once you have read and applied them
|
||||
|
||||
**提交前请遵守每个事项，感谢！**
|
||||
+ PR 标题格式如下：`os/gtime: fixed time zone issues`
|
||||
+ 冒号前是包名
|
||||
+ 冒号后使用动词时态 + 短语
|
||||
+ 冒号后的动词小写
|
||||
+ 不要有结尾句号
|
||||
+ 标题尽量保持简短，最好在 76 个字符或更短
|
||||
+ 标题不要使用 Markdown
|
||||
+ 如果有对应的 issue，请在此评论中添加 `Fixes #1234`，如果不是完全修复则添加 `Updates #1234`
|
||||
+ 应用这些规则后删除所有的说明
|
||||
Reference in New Issue
Block a user