From 32f7342cd6946b1a5afdf5be8100e18588939d5f Mon Sep 17 00:00:00 2001 From: Shivam Mishra Date: Wed, 26 Apr 2023 23:55:02 +0530 Subject: [PATCH] chore: Add issue forms for GitHub (#6982) --- .github/ISSUE_TEMPLATE/bug_report.md | 78 ------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 78 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/enhancement_request.md | 20 ----- .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 28 +++++++ 6 files changed, 114 insertions(+), 118 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/enhancement_request.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 26b053b5f..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: 'Bug' -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 the error - -**Expected behavior** - -Share a clear and concise description of what you expected to happen. - -**Screenshots** - -If applicable, add screenshots to help explain your problem. - -**Browser logs** - -Share the browser logs to debug the issue further. - -**Server logs** - -Share the server logs to debug the issue further. - -**Environment** - -Describe whether you are using Chatwoot Cloud (app.chatwoot.com) or a self-hosted installation of Chatwoot. If you are using a self-hosted installation of Chatwoot, describe the type of deployment (Docker/Linux VM installation/Heroku/Kubernetes/Other). - -- [ ] app.chatwoot.com (Chatwoot Cloud) -- [ ] Self-hosted -- - [ ] Linux VM -- - [ ] Docker -- - [ ] Kubernetes -- - [ ] Heroku -- - [ ] Other (Please specify) - - -**Desktop (please complete the following information)** (If applicable) - - OS: [e.g. Linux, Windows, MacOS] - - Browser [e.g. chrome, firefox, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information)** (If applicable) - - Device: [e.g. iPhone6, Pixel7] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, firefox, safari] - - Version [e.g. 22] - -**Docker** (If applicable) - -Please share the output of the following. -- `docker version` -- `docker info` -- `docker-compose version` - -**Cloud Provider** (If applicable) -- [ ] AWS -- [ ] GCP -- [ ] Azure -- [ ] DigitalOcean -- [ ] Others - -**Additional context** - -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..a0c213dde --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,78 @@ +name: 🐞 Bug report +description: Create a report to help us improve +labels: 'Bug' +body: + - type: textarea + attributes: + label: Describe the bug + description: A concise description of what you expected to happen along with screenshots if applicable. + validations: + required: true + - type: textarea + attributes: + label: To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true + - type: textarea + attributes: + label: Expected behavior + description: A concise description of what you expected to happen. + - type: dropdown + id: environment + attributes: + label: Environment + description: Describe whether you are using Chatwoot Cloud (app.chatwoot.com) or a self-hosted installation of Chatwoot. If you are using a self-hosted installation of Chatwoot, describe the type of deployment (Docker/Linux VM installation/Heroku/Kubernetes/Other). + options: + - app.chatwoot.com + - Linux VM + - Docker + - Kubernetes + - Heroku + - Other [please specify in the description] + validations: + required: true + - type: dropdown + id: provider + attributes: + label: Cloud Provider + description: + options: + - AWS + - GCP + - Azure + - DigitalOcean + - Other [please specify in the description] + - type: dropdown + id: platform + attributes: + label: Platform + description: Describe the platform you are using + options: + - Browser + - Mobile + - type: input + attributes: + label: Operating system + description: The operating system and the version you are using. + - type: input + attributes: + label: Browser and version + description: The name of the browser and version you are using. + - type: textarea + attributes: + label: Docker (if applicable) + description: | + Please share the output of the following. + - `docker version` + - `docker info` + - `docker-compose version` + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..306f5e4a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Report a security issue + url: https://www.chatwoot.com/docs/contributing-guide/security-reports/ + about: Guidelines and steps to report a security vulnerability. Please report security vulnerabilities here. + - name: Product Documentation + url: https://www.chatwoot.com/help-center + about: If you have questions, are confused, or just want to understand our product better, please check out our documentation. diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md deleted file mode 100644 index da1995668..000000000 --- a/.github/ISSUE_TEMPLATE/enhancement_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Enhancement request -about: Suggest any enhancements for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your enhancement 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 you've considered. - -**Additional context** -Add any other context or screenshots about the enhancement request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d6..000000000 --- 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.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..f549bccd7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,28 @@ +name: 🧙 Feature request +description: Suggest an idea for this project +labels: 'feature-request' +body: + - type: textarea + attributes: + label: Is your feature or enhancement related to a problem? Please describe. + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + - type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + - 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 + description: Add any other context or screenshots about the feature request here. + validations: + required: false