diff --git a/.github/ISSUE_TEMPLATE/00-bug.yml b/.github/ISSUE_TEMPLATE/00-bug.yml new file mode 100644 index 000000000..e4f6d109c --- /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: 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 diff --git a/.github/ISSUE_TEMPLATE/01-enhance.yml b/.github/ISSUE_TEMPLATE/01-enhance.yml new file mode 100644 index 000000000..327f64036 --- /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: "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 diff --git a/.github/ISSUE_TEMPLATE/02-feature.yml b/.github/ISSUE_TEMPLATE/02-feature.yml new file mode 100644 index 000000000..43a5394e3 --- /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: "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 diff --git a/.github/ISSUE_TEMPLATE/03-question.yml b/.github/ISSUE_TEMPLATE/03-question.yml new file mode 100644 index 000000000..9735bb2ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-question.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 4fa1cfa12..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - - - - - - - - -**What version of `Go` and system type/arch are you using?** - - - -**What version of `GoFrame` are you using?** - - - -**Can this bug be re-produced with the latest release?** - - -**What did you do?** - - - -**What did you expect to see?** - - -**What did you see instead?** diff --git a/.github/ISSUE_TEMPLATE/enhancement-request.md b/.github/ISSUE_TEMPLATE/enhancement-request.md deleted file mode 100644 index 83fc3ba52..000000000 --- a/.github/ISSUE_TEMPLATE/enhancement-request.md +++ /dev/null @@ -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** diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 5d7685632..000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -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** diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index e0d8ad970..000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: Question -about: I want to ask a question -title: '' -labels: question -assignees: '' - ---- - - -**What do you want to ask** diff --git a/.github/PULL_REQUEST_TEMPLATE.MD b/.github/PULL_REQUEST_TEMPLATE.MD new file mode 100644 index 000000000..9eae273b5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.MD @@ -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` ++ 应用这些规则后删除所有的说明