From afc11e1fa730adc2eca0bb094b65b26d3000d29d Mon Sep 17 00:00:00 2001 From: Carlos Coelho <80289056+carlosrcoelho@users.noreply.github.com> Date: Tue, 16 Jul 2024 11:45:30 -0300 Subject: [PATCH] feat: update bug report template for better issue reporting (#2727) * feat: update bug report template for better issue reporting * feat: Update bug report template for better issue reporting * Create bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update and rename bug-report.yaml to bug-report * Rename bug-report to bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Create feature-request.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update bug-report.yaml * Update feature-request.yaml * Update bug-report.yaml * Delete .github/ISSUE_TEMPLATE/bug_report.yaml --------- Co-authored-by: Gabriel Luiz Freitas Almeida --- .github/ISSUE_TEMPLATE/bug-report.yaml | 117 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 28 ----- .github/ISSUE_TEMPLATE/feature-request.yaml | 30 +++++ 3 files changed, 147 insertions(+), 28 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 000000000..24061970a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,117 @@ +name: "🐛 Bug Report" +description: Submit a bug report to help us improve Langflow +labels: [ "bug" ] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is + placeholder: Tell us what you see! + validations: + required: true + + - type: textarea + id: reproduction + validations: + required: true + attributes: + label: Reproduction + description: | + Please provide a code sample 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, or stack traces please provide them here as well. + Important! Use code tags to format your code correctly. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting + Do not use screenshots, 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." + + - type: textarea + id: who-can-help + attributes: + label: Who can help? + description: | + Your issue will be replied to more quickly if you can figure out the right person to tag with @. + If you know the relevant code owner, please tag them. Otherwise, leave this blank and a core maintainer will direct the issue accordingly. + + Please tag fewer than 3 people. + + Specific Areas: + + Frontend: + - @anovazzi1 + - @Cristhianzl + - @lucaseduoli + - @igorrCarvalho + + Backend: + - @italojohnny + + Full Stack: + - @ogabrielluiz + - @nicoloboschi + - @zzzming + - @jordanrfrazier + - @mfortman11 + - @NadirJ + + placeholder: "@Username ..." + + - type: markdown + attributes: + value: '## Environment' + + - type: input + id: os + attributes: + label: Operating System + placeholder: ex. Ubuntu Linux 22.04 + validations: + required: true + + - type: input + id: langflow-version + attributes: + label: Langflow Version + placeholder: ex. 1.0.9 + validations: + required: true + + - type: checkboxes + id: python-version + attributes: + label: Python Version + description: | + My Python version is: + + Langflow requires Python version 3.10 or greater. + options: + - label: "3.12" + - label: "3.11" + - label: "3.10" + + - type: markdown + attributes: + value: | + Screenshot error - If applicable, add screenshots to help explain your problem. + + - type: markdown + attributes: + value: | + Flow file - Add your flow if applicable to help replicate the problem. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c2c42d27d..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,28 +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. - -**Browser and Version** - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 000000000..6b494c6f7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,30 @@ +name: "🚀 Feature Request" +description: Submit a proposal/request for a new Langflow feature +labels: [ "enhancement" ] +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 any relevant links to papers, code, or other resources that support your proposal. + + - 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 it here as well. + + - 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 guidelines for Langflow before proceeding.