From 89e92ac064a01b711a41e22b6e69478eb90e4bc3 Mon Sep 17 00:00:00 2001 From: moremind Date: Tue, 19 Mar 2024 23:01:36 +0800 Subject: [PATCH] [type:issue] add issue template --- .github/ISSUE_TEMPLATE/bug-report.yml | 61 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature-request.yml | 39 ++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 18 +++++++ .github/ISSUE_TEMPLATE/task.yml | 25 +++++++++ .github/ISSUE_TEMPLATE/volunteer.yml | 17 ++++++ 6 files changed, 161 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml create mode 100644 .github/ISSUE_TEMPLATE/task.yml create mode 100644 .github/ISSUE_TEMPLATE/volunteer.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..649f72a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,61 @@ +name: 🐛 Bug Report +description: Problems and issues with code of Grok-1 🤔. +title: "[BUG] " +labels: ["type: bug"] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: false +- type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: false +- type: textarea + attributes: + label: Environment + description: | + examples: + - **Python version(s)**: 3.6.0 + value: "Python version(s):" + render: markdown + validations: + required: false +- type: textarea + attributes: + label: Debug logs + description: | + Add your debug logs here. + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..458e237 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,39 @@ +name: 🚀 Feature Request +description: I have a suggestion (and may want to implement it 🙂)! +title: "[Feature] <title>" +labels: ["type: new feature"] +body: +- type: textarea + attributes: + label: Feature Request + description: > + Tip: Have you checked GitHub issues whether someone else has already reported your issue? Maybe the feature already exists? + placeholder: > + A concise description of what you're experiencing. + validations: + required: false +- type: textarea + attributes: + label: Is your feature request related to a problem? Please describe + description: A clear and concise description of what the problem is. Ex. I have an issue when [...] + validations: + required: false +- type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. Add any considered drawbacks. + validations: + required: false +- type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false +- type: textarea + attributes: + label: Additional context + validations: + required: false +- type: markdown + value: "Please read the README before submitting the PR" diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..2e5584e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,18 @@ +name: 🤔 Question +description: Usage question that isn't answered in docs or discussion +title: "[Question] <title>" +labels: ["type: question"] +body: +- type: textarea + attributes: + label: Question + placeholder: > + your question here; + validations: + required: true +- type: markdown + attributes: + value: | + Please pay attention on issues you submitted, because we maybe need more details. + If no response anymore and we cannot reproduce it on current information, we will **close it**. + diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 0000000..f5a70a8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -0,0 +1,25 @@ +name: 🚀 Task +description: Used to create tasks for the community. +title: "[Task] <title>" +labels: ["status: volunteer wanted"] +body: +- type: textarea + attributes: + label: Description + placeholder: A clear and concise description of Task + validations: + required: true +- type: textarea + attributes: + label: Task List + placeholder: | + 1. Task1... + 2. Task2... + 3. Task3... + 4. Task4... + validations: + required: false +- type: markdown + attributes: + value: | + Please read the README before submitting the PR diff --git a/.github/ISSUE_TEMPLATE/volunteer.yml b/.github/ISSUE_TEMPLATE/volunteer.yml new file mode 100644 index 0000000..5084a20 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/volunteer.yml @@ -0,0 +1,17 @@ +name: 🤔 Volunteer +description: Some volunteer help +title: "[Volunteer] <title>" +labels: ["status: volunteer wanted"] +body: +- type: textarea + attributes: + label: Volunteer help + placeholder: > + your need volunteer help here; + validations: + required: true +- type: markdown + attributes: + value: | + Please read the README before submitting the PR +