feature: update issue template (#83)

This commit is contained in:
libin
2024-08-13 13:49:25 +08:00
committed by GitHub
parent a723bd549f
commit 43a73909e9
12 changed files with 267 additions and 73 deletions

53
.github/ISSUE_TEMPLATE/01.bug.md vendored Normal file
View File

@@ -0,0 +1,53 @@
---
name: 🐛 Bug report
about: Create a report to help us improve
title: "[Bug]: "
labels: "bug"
assignees: ""
---
<!--
Please ensure you have read the contribution guidelines and code of conduct.
Before submitting a bug report, please search existing issues and pull requests to see if the bug has already been reported.
-->
**Environment information**
- Operating system: [e.g., MacOS]
- Go version: [e.g., 1.18]
- Package version: [e.g., v1.2.3]
**Describe the bug**
Clearly describe what the bug is.
**Steps to reproduce**
1. Use method '...'
2. Observe the bug
Alternatively, it would be helpful if you could provide a simplified code example that triggers the bug.
**Expected behavior**
Describe how you expect the program to respond.
**Actual behavior**
Describe how the program actually responds.
**Screenshots or videos (if available)**
If possible, provide screenshots or videos that demonstrate the bug.
**Additional context**
Please provide any other information here that might help us diagnose the issue.
**Additional information**
- Error log (if available):

38
.github/ISSUE_TEMPLATE/02.feature.md vendored Normal file
View File

@@ -0,0 +1,38 @@
---
name: 🚀 Feature request
about: Make creative suggestions for this package
title: "[Feature]: "
labels: "feature"
assignees: ""
---
<!--
Please ensure you have read the contribution guidelines and code of conduct.
Before submitting a feature request, please search existing issues and pull requests to avoid duplication.
-->
**Feature Description and Necessity**
Please describe in detail your proposed new feature and its importance to this package.
- Feature Overview:
- Necessity:
**Suggestions and Solutions**
Do you have any specific suggestions or solutions on how to implement this feature? Please share them here.
- Suggested Implementation:
- Possible Alternatives (if any):
**Other Considerations**
- How will this feature integrate with existing features?
- Does it require any new dependencies or third-party services?
- Are there any potential security issues or performance impacts?
**Additional Information**
Please provide any additional information or context here that may help us understand and evaluate your feature request.

23
.github/ISSUE_TEMPLATE/03.document.md vendored Normal file
View File

@@ -0,0 +1,23 @@
---
name: 📚 Documentation Improvement
about: Report errors, omissions, or suggestions for improvement in the documentation
title: '[Documentation Improvement]: '
labels: documentation
assignees: ''
---
**Document Improvement Description**
Please describe the documentation issue you found or the improvement you would like to see.
- Document location (URL or file name):
- Problem description or improvement suggestion:
**Screenshots or examples (if available)**
If possible, please provide screenshots or sample code to help illustrate the issue.
**Additional Information**
Please provide any other information here that may help us understand and improve the documentation.

22
.github/ISSUE_TEMPLATE/04.ask.md vendored Normal file
View File

@@ -0,0 +1,22 @@
---
name: 🤔 Ask a Question
about: Ask a question about the project, usage, or configuration
title: '[Question]: '
labels: question
assignees: ''
---
**Problem description**
Please describe your problem clearly and concisely.
- Problem background:
- Tried solutions (if any):
**Relevant code or configuration (if any)**
Please provide code snippets or configuration file contents related to the problem.
**Additional information**
Please provide any other information here that may help answer your question.

50
.github/ISSUE_TEMPLATE/11.bug.cn.md vendored Normal file
View File

@@ -0,0 +1,50 @@
---
name: 🐛 错误报告
about: 创建报告以帮助我们改进
title: "[Bug]: "
labels: "bug"
assignees: ""
---
<!--
请确保你已经阅读了项目的贡献指南和代码风格指南。
在提交bug报告之前请搜索现有的问题和拉取请求以查看是否已有人报告了相同的bug。
-->
**环境信息**
- 操作系统: [例如MacOS]
- Go版本: [例如1.18]
- 包版本: [例如v1.2.3]
**描述bug**
清晰地描述你遇到的bug是什么。
**复现步骤**
1. 使用方法 '...'
2. 观察到bug发生
或者如果你能提供触发bug的简化代码示例那将非常有帮助。
**预期行为**
描述你期望程序如何响应。
**实际行为**
描述程序实际是如何响应的。
**截图或视频(如果有的话)**
如果可能请提供截图或视频来展示bug。
**其他上下文**
请在此处提供任何其他可能有助于我们诊断问题的信息。
**附加信息**
- 错误日志(如果有的话):

36
.github/ISSUE_TEMPLATE/12.feature.cn.md vendored Normal file
View File

@@ -0,0 +1,36 @@
---
name: 🚀 功能需求
about: 为此包提出一个创意想法
title: "[Feature]: "
labels: "feature"
assignees: ""
---
<!--
请确保你已经阅读了项目的贡献指南和代码风格指南。
在提交特性请求之前,请搜索现有的问题和拉取请求,以避免重复工作。
-->
**功能描述以及必要性描述**
请详细描述你建议的新功能,以及它为何对此包很重要。
- 功能概述:
- 必要性描述:
**建议和方案**
你有关于如何实现这个功能的任何具体建议或方案吗?请在这里分享。
- 建议的实现方案:
- 可能的替代方案(如果有的话):
**其他考虑因素**
- 这个功能将如何与现有的功能集成?
- 它是否需要任何新的依赖项或第三方服务?
- 是否有任何潜在的安全问题或性能影响?
**附加信息**
请在此处提供任何额外的信息或上下文,这些信息可能有助于我们理解和评估你的特性请求。

View File

@@ -0,0 +1,23 @@
---
name: 📚 文档改进
about: 报告文档中的错误、缺失或改进建议
title: '[文档改进]: '
labels: documentation
assignees: ''
---
**文档改进描述**
请详细描述您发现的文档问题或改进建议。
- 文档位置URL或文件名:
- 问题描述或改进建议:
**截图或示例(如果有的话)**
如果可能,请提供截图或示例代码来辅助说明问题。
**其他信息**
请在此处提供任何其他可能有助于我们理解并改进文档的信息。

22
.github/ISSUE_TEMPLATE/14.ask.cn.md vendored Normal file
View File

@@ -0,0 +1,22 @@
---
name: 🤔 提问
about: 询问关于项目、使用或配置的问题
title: '[提问]: '
labels: question
assignees: ''
---
**问题描述**
请清晰、简洁地描述您的问题。
- 问题背景:
- 尝试过的解决方案(如果有的话):
**相关代码或配置(如果有的话)**
请提供与问题相关的代码片段或配置文件内容。
**其他信息**
请在此处提供任何其他可能有助于解答您问题的信息。

View File

@@ -1,16 +0,0 @@
---
name: "❓ Ask question"
about: Ask a question about GoEasyUtils
labels: Question
---
<!--
Before asking a question, make sure you have:
- Searched existing Stack Overflow questions.
- Googled your question.
- Searched open and closed [GitHub issues](https://github.com/jefferyjob/go-easy-utils/issues?utf8=%E2%9C%93&q=is%3Aissue)
- Read the documentation:
- [GoEasyUtils Readme](https://github.com/jefferyjob/go-easy-utils)
-->

View File

@@ -1,33 +0,0 @@
---
name: "\U0001F41B Bug report"
about: Report a reproducible bug or regression.
labels: Bug
---
Hello,
I encountered an issue with the following code:
```go
var slice = []string{"this", "is", "go", "easy", "utils"}
chunkSlice := sliceUtil.ChunkStr(slice, 2)
```
golang version: **such as 1.16**
carbon version: **such as 1.0.1**
I expected to get:
```
[]string{"this", "is"}
[]string{"go", "easy"}
[]string{"utils"}
```
But I actually get:
```
[]string{"this", "is"}
[]string{"go", "easy", "utils"}
```
Thanks!

View File

@@ -1,5 +0,0 @@
---
name: "\U0001F4C3 Document improvement"
about: Improvements or additions to document
labels: Documentation
---

View File

@@ -1,19 +0,0 @@
---
name: "\U0001F680 Feature request"
about: Suggest an idea for GoEasyUtils
labels: Feature
---
## Feature Request
**Is your feature request related to a problem? Please describe:**
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
**Describe the feature you'd like:**
<!-- A clear and concise description of what you want to happen. -->
**Describe alternatives you've considered:**
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
**Teachability, Documentation, Adoption, Migration Strategy:**
<!-- If you can, explain some scenarios how users might use this, situations it would be helpful in. Any API designs, mockups, or diagrams are also helpful. -->