From b95ad4fcbcd665c04661d1dee30b2edc67ab20b2 Mon Sep 17 00:00:00 2001 From: Calcitem Date: Sat, 29 Apr 2023 01:57:54 +0800 Subject: [PATCH] github: Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..0b7afbd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug 报告 / Bug Report +about: 报告项目中的错误或问题 / Report errors or issues in the project +title: "[BUG] 简洁阐述问题 / Concise description of the issue" +labels: bug +assignees: '' + +--- + +**问题描述 / Problem Description** +用简洁明了的语言描述这个问题 / Describe the problem in a clear and concise manner. + +**复现问题的步骤 / Steps to Reproduce** +1. 执行 '...' / Run '...' +2. 点击 '...' / Click '...' +3. 滚动到 '...' / Scroll to '...' +4. 问题出现 / Problem occurs + +**预期的结果 / Expected Result** +描述应该出现的结果 / Describe the expected result. + +**实际结果 / Actual Result** +描述实际发生的结果 / Describe the actual result. + +**环境信息 / Environment Information** +- langchain-ChatGLM 版本/commit 号:(例如:v1.0.0 或 commit 123456) / langchain-ChatGLM version/commit number: (e.g., v1.0.0 or commit 123456) +- 是否使用 Docker 部署(是/否):是 / Is Docker deployment used (yes/no): yes +- 使用的模型(ChatGLM-6B / ClueAI/ChatYuan-large-v2 等):ChatGLM-6B / Model used (ChatGLM-6B / ClueAI/ChatYuan-large-v2, etc.): ChatGLM-6B +- 使用的 Embedding 模型(GanymedeNil/text2vec-large-chinese 等):GanymedeNil/text2vec-large-chinese / Embedding model used (GanymedeNil/text2vec-large-chinese, etc.): GanymedeNil/text2vec-large-chinese +- 操作系统及版本 / Operating system and version: +- Python 版本 / Python version: +- 其他相关环境信息 / Other relevant environment information: + +**附加信息 / Additional Information** +添加与问题相关的任何其他信息 / Add any other information related to the issue. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..f53d2a2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: 功能请求 / Feature Request +about: 为项目提出新功能或建议 / Propose new features or suggestions for the project +title: "[FEATURE] 简洁阐述功能 / Concise description of the feature" +labels: enhancement +assignees: '' + +--- + +**功能描述 / Feature Description** +用简洁明了的语言描述所需的功能 / Describe the desired feature in a clear and concise manner. + +**解决的问题 / Problem Solved** +解释此功能如何解决现有问题或改进项目 / Explain how this feature solves existing problems or improves the project. + +**实现建议 / Implementation Suggestions** +如果可能,请提供关于如何实现此功能的建议 / If possible, provide suggestions on how to implement this feature. + +**替代方案 / Alternative Solutions** +描述您考虑过的替代方案 / Describe alternative solutions you have considered. + +**其他信息 / Additional Information** +添加与功能请求相关的任何其他信息 / Add any other information related to the feature request. \ No newline at end of file