From 9e0bfcfc14c8652428742dde66a1c6a1bf625cdf Mon Sep 17 00:00:00 2001 From: hiyouga Date: Thu, 16 Nov 2023 19:35:30 +0800 Subject: [PATCH] add issue template --- .github/ISSUE_TEMPLATE/bug-report.yml | 58 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/🐛-bug---help.md | 23 ---------- 2 files changed, 58 insertions(+), 23 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/🐛-bug---help.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..5bcdbb39 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,58 @@ +name: "\U0001F41B Bug / Help" +description: Create a report to help us improve the LLaMA Factory +body: + - type: checkboxes + id: reminder + attributes: + label: Reminder + description: | + Please ensure you have read the README carefully and searched the existing issues. + 请确保您已经认真阅读了 README 并且搜索过现有的 Issue。 + + options: + - label: I have read the README and searched the existing issues. + required: true + + - type: textarea + id: reproduction + validations: + required: true + attributes: + label: Reproduction + description: | + Please provide code snippets, error messages and stack traces that reproduces the problem. + 请提供运行参数,错误信息以及异常堆栈以便于我们复现该问题。 + Remember to use Markdown tags to correctly format your code. + 请合理使用 Markdown 标签来格式化您的文本。 + + placeholder: | + python src/train_bash.py ... + + - type: textarea + id: expected-behavior + validations: + required: false + attributes: + label: Expected behavior + description: | + Please provide a clear and concise description of what you would expect to happen. + 请提供您原本的目的,即这段代码的期望行为。 + + - type: textarea + id: system-info + validations: + required: true + attributes: + label: System Info + description: | + Please share your system info with us. You can run the command **transformers-cli env** and copy-paste its output below. + 请提供您的系统信息。您可以在命令行运行 **transformers-cli env** 并将其输出复制到该文本框中。 + + placeholder: transformers version, platform, python version, ... + + - type: textarea + id: others + validations: + required: false + attributes: + label: Others diff --git a/.github/ISSUE_TEMPLATE/🐛-bug---help.md b/.github/ISSUE_TEMPLATE/🐛-bug---help.md deleted file mode 100644 index b1db8fb8..00000000 --- a/.github/ISSUE_TEMPLATE/🐛-bug---help.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: "\U0001F41B Bug / Help" -about: Create a report to help us improve the library -title: '' -labels: '' -assignees: '' - ---- - -**Running Command** -python src/train_bash.py ... - -**System Info** -Please share your system info with us. You can run the command `transformers-cli env` and copy-paste its output below. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here.