From d1e65e8d1c3595e6d2b58a0a4449851c47a2294f Mon Sep 17 00:00:00 2001 From: Richard Guo Date: Thu, 18 May 2023 13:11:45 -0400 Subject: [PATCH] Issue Management (#628) * better issue templates, forcing issue template * close issues workflow * closeissues workflow change --- .github/ISSUE_TEMPLATE/bug-report.yml | 70 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 42 ------------- .github/ISSUE_TEMPLATE/config.yml | 2 + .github/ISSUE_TEMPLATE/documentation.yml | 19 ++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 30 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 -------- .github/ISSUE_TEMPLATE/other.yml | 18 ++++++ .github/workflows/close_issues.yml | 26 ++++++++ 8 files changed, 165 insertions(+), 66 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/other.yml create mode 100644 .github/workflows/close_issues.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..6c3712c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,70 @@ +name: "\U0001F41B Bug Report" +description: Submit a bug report to help us improve GPT4All +labels: ["02 Bug Report"] +body: + - type: markdown + attributes: + value: > + Thank you for taking the time to file a bug report. Before creating a new + issue, please make sure to take a few moments to check the issue tracker + for existing issues about the bug. + + - type: textarea + id: system-info + attributes: + label: System Info + description: Please share your system info with us. + placeholder: GPT4All version, platform, python version, etc... + validations: + required: true + + - type: checkboxes + id: information-scripts-examples + attributes: + label: Information + description: "The problem arises when using:" + options: + - label: "The official example notebooks/scripts" + - label: "My own modified scripts" + + - type: checkboxes + id: related-components + attributes: + label: Related Components + description: "Select the components related to the issue (if applicable):" + options: + - label: "backend" + - label: "bindings" + - label: "python-bindings" + - label: "chat-ui" + - label: "models" + - label: "circleci" + - label: "docker" + - label: "api" + + - type: textarea + id: reproduction + validations: + required: true + attributes: + label: Reproduction + description: | + Please provide a [code sample](https://stackoverflow.com/help/minimal-reproducible-example) that reproduces the problem you ran into. It can be a Colab link or just a code snippet. + If you have code snippets, error messages, stack traces please provide them here as well. + Important! Use code tags to correctly format your code. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting + Avoid screenshots when possible, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code. + + placeholder: | + Steps to reproduce the behavior: + + 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/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 51b8b84b..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. - -**Label Tagging** -Add related label tags to your bug report. Please check all existing label tags before creating a new one. -Issues without labels may be dismissed. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..8ae3dc42 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,2 @@ +blank_issues_enabled: false +version: 2.1 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..0b8626f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,19 @@ +name: Documentation +description: Report an issue related to the GPT4All documentation. +title: "DOC: " +labels: [03 - Documentation] + +body: +- type: textarea + attributes: + label: "Issue with current documentation:" + description: > + Please make sure to leave a reference to the document/code you're + referring to. + +- type: textarea + attributes: + label: "Idea or request for content:" + description: > + Please describe as clearly as possible what topics you think are missing + from the current documentation. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..92282dbd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,30 @@ +name: "\U0001F680 Feature Request" +description: Submit a proposal/request for a new GPT4All feature +labels: ["02 Feature Request"] +body: + - type: textarea + id: feature-request + validations: + required: true + attributes: + label: Feature request + description: | + A clear and concise description of the feature proposal. Please provide links to any relevant GitHub repos, papers, or other resources if relevant. + + - type: textarea + id: motivation + validations: + required: true + attributes: + label: Motivation + description: | + Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too. + + - type: textarea + id: contribution + validations: + required: true + attributes: + label: Your contribution + description: | + Is there any way that you could help, e.g. by submitting a PR? Make sure to read the CONTRIBUTING.MD [readme](https://github.com/nomic-ai/gpt4all/blob/main/CONTRIBUTING.md) \ 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 2dfd0b43..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +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. - -**Label Tagging** -Add related label tags to your feature request. Please check all existing label tags before creating a new one. -Issues without labels may be dismissed. diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml new file mode 100644 index 00000000..c0068f0f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.yml @@ -0,0 +1,18 @@ +name: Other Issue +description: Raise an issue that wouldn't be covered by the other templates. +title: "Issue: " +labels: [04 - Other] + +body: + - type: textarea + attributes: + label: "Issue you'd like to raise." + description: > + Please describe the issue you'd like to raise as clearly as possible. + Make sure to include any relevant links or references. + + - type: textarea + attributes: + label: "Suggestion:" + description: > + Please outline a suggestion to improve the issue here. \ No newline at end of file diff --git a/.github/workflows/close_issues.yml b/.github/workflows/close_issues.yml new file mode 100644 index 00000000..5f476f87 --- /dev/null +++ b/.github/workflows/close_issues.yml @@ -0,0 +1,26 @@ +# This workflow will close issues that do not have labels or additional comments. +# Trigger manually. + +name: "Close Issues" +on: + workflow_dispatch: + +jobs: + close_issues: + runs-on: ubuntu-latest + steps: + - name: Close issues without label or comment + uses: actions/github-script@v3 + with: + github-token: ${{secrets.GITHUB_TOKEN}} + script: | + const repo = context.repo; + const issues = await github.issues.listForRepo(repo); + for (let { number } of issues.data) { + const issueData = await github.issues.get({...repo, issue_number: number}); + const comments = await github.issues.listComments({...repo, issue_number: number}); + if (issueData.data.labels.length === 0 && comments.data.length < 1) { + await github.issues.update({...repo, issue_number: number, state: 'closed'}); + await github.issues.createComment({...repo, issue_number: number, body: 'Issue closed as it does not have any labels or comments.'}); + } + } \ No newline at end of file