From 7fb3755d62c3901d8b1c368b2adb7d252b083d93 Mon Sep 17 00:00:00 2001 From: Chengjie Li <109656400+ChengjieLi28@users.noreply.github.com> Date: Wed, 10 Jul 2024 18:44:39 +0800 Subject: [PATCH] CHORE: Update issue template (#1833) --- .github/ISSUE_TEMPLATE/bug_report.md | 26 ------- .github/ISSUE_TEMPLATE/bug_report.yaml | 77 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ------ .github/ISSUE_TEMPLATE/feature_request.yaml | 34 +++++++++ .github/ISSUE_TEMPLATE/other.md | 10 --- .github/ISSUE_TEMPLATE/question.md | 9 --- 6 files changed, 111 insertions(+), 65 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/other.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 450524693f..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "BUG" -labels: '' -assignees: '' - ---- - -### Describe the bug -A clear and concise description of what the bug is. - -### To Reproduce -To help us to reproduce this bug, please provide information below: - -1. Your Python version. -2. The version of xinference you use. -3. Versions of crucial packages. -4. Full stack of the error. -5. Minimized code to reproduce the error. - -### Expected behavior -A clear and concise description of what you expected to happen. - -### Additional context -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000000..dd62dee44a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,77 @@ +name: "Bug Report" +description: Submit a bug report to help us improve Xinference. You should provide useful information AMAP rather than simply describing what happened. / 提交一个问题报告来帮助我们改进 Xinference。你必须提供有用的信息而不只是描述发生的现象，否则将不予处理。 +body: + - type: textarea + id: system-info + attributes: + label: System Info / 系統信息 + description: Your operating environment / 您的运行环境信息 + placeholder: Includes Cuda version, transformers / llama-cpp-python / vllm version, Python version, operating system... / 包括Cuda版本，transformers / llama-cpp-python / vllm版本，Python版本，操作系统等。 + validations: + required: true + + - type: checkboxes + id: information-scripts-examples + attributes: + label: Running Xinference with Docker? / 是否使用 Docker 运行 Xinfernece？ + description: 'How are you using Xinference? / 以何种方式使用 Xinference？' + options: + - label: docker / docker + - label: pip install / 通过 pip install 安装 + - label: installation from source / 从源码安装 + + - type: textarea + id: start-way + attributes: + label: Version info / 版本信息 + description: The version of Xinference you are running / Xinference 版本 + validations: + required: true + + - type: textarea + id: commandline + attributes: + label: The command used to start Xinference / 用以启动 xinference 的命令 + description: | + Please provide the command used to start Xinference. + If it is a distributed scenario, the commands for starting the supervisor and worker need to be listed separately. + If it is a Docker scenario, please provide the complete command for starting Xinference through Docker. + If it is another method, please describe it specifically. + + 请提供启动 xinference 的命令。 + 如果是分布式场景，启动 supervisor 和 worker 的命令需要分别列出。 + 如果是docker场景，请提供通过 docker 启动 xinference 的完整命令。 + 如果是其他方式，请具体描述。 + validations: + required: true + + - type: textarea + id: reproduction + validations: + required: true + attributes: + label: Reproduction / 复现过程 + description: | + Please provide a code example that reproduces the problem you encountered, preferably with a minimal reproduction unit. + If you have code snippets, error messages, stack traces, please provide them here as well. + Please format your code correctly using code tags. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting + Do not use screenshots, as they are difficult to read and (more importantly) do not allow others to copy and paste your code. + + 请提供能重现您遇到的问题的代码示例,最好是最小复现单元。 + 如果您有代码片段、错误信息、堆栈跟踪、涉及的命令行操作等也请在此提供。 + 请使用代码标签正确格式化您的代码。请参见 https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting + 请勿使用截图，因为截图难以阅读，而且（更重要的是）不允许他人复制粘贴您的代码。 + placeholder: | + Steps to reproduce the behavior/复现Bug的步骤: + + 1. + 2. + 3. + + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: Expected behavior / 期待表现 + description: "A clear and concise description of what you would expect to happen. / 简单描述您期望发生的事情。" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index a61ec537d4..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -### 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 solution 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. - -### Additional context -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000000..81bac43d89 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,34 @@ +name: "Feature request" +description: Submit a request for a new Xinference feature / 提交一个新的 Xinference 的功能建议 +labels: [ "feature" ] +body: + - type: textarea + id: feature-request + validations: + required: true + attributes: + label: Feature request / 功能建议 + description: | + A brief description of the functional proposal. + 对功能建议的简述。 + + - type: textarea + id: motivation + validations: + required: true + attributes: + label: Motivation / 动机 + description: | + Your motivation for making the suggestion. If that motivation is related to another GitHub issue, link to it here. + 您提出建议的动机。如果该动机与另一个 GitHub 问题有关，请在此处提供对应的链接。 + + - type: textarea + id: contribution + validations: + required: true + attributes: + label: Your contribution / 您的贡献 + description: | + + Your PR link or any other link you can help with. + 您的PR链接或者其他您能提供帮助的链接。 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md deleted file mode 100644 index 02357a9207..0000000000 --- a/.github/ISSUE_TEMPLATE/other.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Other -about: Submit other issues here. -title: '' -labels: '' -assignees: '' - ---- - -Note that the issue tracker is NOT the place for general support. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 4510ec6419..0000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -name: Question -about: Ask a question here. -title: 'QUESTION' -labels: 'question' -assignees: '' ---- - -Note that the issue tracker is NOT the place for general support.