From 8babd52b8182525e9b17b5c76a539302b3b97399 Mon Sep 17 00:00:00 2001 From: Devin Binnie <52460000+devinbinnie@users.noreply.github.com> Date: Tue, 7 Feb 2023 08:58:06 -0500 Subject: [PATCH] [MM-50250] Revised Issue Templates with Issue Forms (#2546) * [MM-50250] Revised Issue Templates with Issue Forms * Typo * More typos * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/crash_report.yml Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> --------- Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/beta_report.md | 39 ---------- .github/ISSUE_TEMPLATE/bug_report.md | 39 ---------- .github/ISSUE_TEMPLATE/bug_report.yml | 76 +++++++++++++++++++ .github/ISSUE_TEMPLATE/crash_report.yml | 72 ++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 9 --- .../troubleshooting-question.md | 7 -- .../ISSUE_TEMPLATE/upgrade-dependencies.md | 31 -------- ISSUE_TEMPLATE.md | 41 ---------- PULL_REQUEST_TEMPLATE.md | 22 ------ 9 files changed, 148 insertions(+), 188 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/beta_report.md delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/crash_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/troubleshooting-question.md delete mode 100644 .github/ISSUE_TEMPLATE/upgrade-dependencies.md delete mode 100644 ISSUE_TEMPLATE.md delete mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/beta_report.md b/.github/ISSUE_TEMPLATE/beta_report.md deleted file mode 100644 index 3b757674..00000000 --- a/.github/ISSUE_TEMPLATE/beta_report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Beta Testing Report -about: Report issues found while using a beta version of the Mattermost Desktop App - ---- - -I confirm (by marking "x" in the [ ] below: [x]): - -- [ ] I have confirmed this is an issue on the newest beta build [available here](https://github.com/mattermost/desktop/tags) -- [ ] This issue doesn't reproduce on web browsers (such as in Chrome). If it does, [issue reports go to the Mattermost Server repository](https://github.com/mattermost/platform/issues). -- [ ] I have read [contributing guidelines](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md). - ---- - -**Summary** - - -**Environment** -- Operating System: -- Mattermost Desktop App version: X.X.X -- Mattermost Server version: X.X.X - -**Steps to reproduce** - -**Expected behavior** - -**Observed behavior** - - - -**Possible fixes** - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 781e36cb..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Bug report -about: Create a report about an issue you found - ---- - -I confirm (by marking "x" in the [ ] below: [x]): - -- [ ] This is not a troubleshooting question. [Troubleshooting questions go here: https://docs.mattermost.com/install/troubleshooting.html](https://docs.mattermost.com/install/troubleshooting.html). -- [ ] This doesn't reproduce on web browsers (such as in Chrome). If it does, [issue reports go to the Mattermost Server repository](https://github.com/mattermost/platform/issues). -- [ ] I have read [contributing guidelines](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md). - ---- - -**Summary** - - -**Environment** -- Operating System: -- Mattermost Desktop App version: X.X.X -- Mattermost Server version: X.X.X - -**Steps to reproduce** - -**Expected behavior** - -**Observed behavior** - - - -**Possible fixes** - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..1c5f88be --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,76 @@ +name: Bug report +description: Create a report about an issue you found in the Mattermost Desktop App +title: "[Bug]: " +labels: "Type/Bug" +body: +- type: checkboxes + attributes: + label: Before you file a bug report + description: Please ensure you can confirm the following + options: + - label: I have checked the [issue tracker](https://github.com/mattermost/desktop/issues) and have not found an issue that matches the one I'm filing. + required: true + - label: "This issue is not a troubleshooting question. Troubleshooting questions go here: https://forum.mattermost.com/c/trouble-shoot/16." + required: true + - label: "This issue is not a feature request. You can request features and make product suggestions here: https://mattermost.com/suggestions/." + required: true + - label: This issue doesn't reproduce on web browsers (such as in Chrome). If it does, [issue reports go to the Mattermost Server repository](https://github.com/mattermost/mattermost-server/issues). + required: true + - label: I have read the [contribution guidelines](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md). + required: true +- type: input + attributes: + label: Mattermost Desktop Version + description: | + What version of the Desktop App are you using? You can find it by going to [Help] > [Version Number]. + validations: + required: true +- type: input + attributes: + label: Operating System + description: | + What operating system does this issue occur on? Please include the distribution name (if necessary) and architecture. + + Examples: + - Windows 10 x64 + - macOS Ventura 13.2 Apple Silicon + - Ubuntu Linux 22.04 LTS x64 + validations: + required: true +- type: input + attributes: + label: Mattermost Server Version + description: | + Which version of the Mattermost Server did this occur on? + You can find your Mattermost Server version by [Mattermost Menu] > [About Mattermost], where [Mattermost Menu] can be accessed by clicking on the grid in the top-left corner. +- type: textarea + attributes: + label: Steps to reproduce + description: | + Include a clear description of the steps taken to reproduce this issue. + It is also helpful to attach a screenshot or video if applicable. + validations: + required: true +- type: textarea + attributes: + label: Expected behavior + description: Include a clear description of what you expect to happen. + validations: + required: true +- type: textarea + attributes: + label: Observed behavior + description: Include a clear description of what actually happens. + validations: + required: true +- type: textarea + attributes: + label: Log Output + description: Please include output from the log files. You can find the location of the log files by going to [Help] > [Show logs]. + render: shell + validations: + required: true +- type: textarea + attributes: + label: Additional Information + description: If you have anything else to add to the ticket, you may do so here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/crash_report.yml b/.github/ISSUE_TEMPLATE/crash_report.yml new file mode 100644 index 00000000..1792134a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/crash_report.yml @@ -0,0 +1,72 @@ +name: Crash report +description: Create a report about a crash you experienced while using the Mattermost Desktop App +title: "[Crash]: " +labels: "Type/Crash Report" +body: +- type: checkboxes + attributes: + label: Before you file a crash report + description: Please ensure you can confirm the following + options: + - label: I have checked the [issue tracker](https://github.com/mattermost/desktop/issues) and have not found an issue that matches the one I'm filing. + required: true + - label: This issue doesn't reproduce on web browsers (such as in Chrome). If it does, [issue reports go to the Mattermost Server repository](https://github.com/mattermost/mattermost-server/issues). + required: true + - label: I have read the [contribution guidelines](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md). + required: true +- type: input + attributes: + label: Mattermost Desktop Version + description: | + What version of the Desktop App are you using? You can find it by going to [Help] > [Version Number]. If you cannot access that, please check which version you downloaded, or ask your system administrator. + validations: + required: true +- type: input + attributes: + label: Operating System + description: | + What operating system does this issue occur on? Please include the distribution name (if necessary) and architecture. + + Examples: + - Windows 10 x64 + - macOS Ventura 13.2 Apple Silicon + - Ubuntu Linux 22.04 LTS x64 + validations: + required: true +- type: input + attributes: + label: Mattermost Server Version + description: | + Which version of the Mattermost Server did this occur on? + You can find your Mattermost Server version by [Mattermost Menu] > [About Mattermost], where [Mattermost Menu] can be accessed by clicking on the grid in the top-left corner. + If you cannot access this, ask your system administrator. +- type: dropdown + attributes: + label: What type of crash did you experience? + options: + - White screen (I can see the top bar, but I cannot see my Mattermost server) + - Uncaught exception (I saw a dialog pop up that said "The Mattermost app quit unexpectedly") + - System crash (The application quit unexpectedly with no warning, or the operating system reported a crash) + validations: + required: true +- type: textarea + attributes: + label: Crash report details + description: | + Please provide any information you can about the crash you experienced. + + - White screen: If you experience a white screen, please first verify that the same behaviour doesn't reproduce on the browser and if it doesn't, you can go to [View] > [Developer Tools for Current Server], clicking on the Console tab, then right-clicking on the logs area and clicking [Save as]. Then you can copy and paste the contents of that file here. + - Uncaught exception: If you receive a dialog that says "The Mattermost app quit unexpectedly", click on the Show Details button. Copy the text that is shown and paste it there. + - System crash: For any other crashes, please provide the trace log or Event Viewer output or anything else that might be relevant here. + render: shell + validations: + required: true +- type: textarea + attributes: + label: Log Output + description: Please include output from the log files if relevant. You can find the location of the log files by going to [Help] > [Show logs]. If you cannot access that, you can find them [here](https://docs.mattermost.com/install/troubleshooting.html#mattermost-desktop-app-logs). + render: shell +- type: textarea + attributes: + label: Additional Information + description: If you have anything else to add to the ticket, you may do so here. \ 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 f0ad1062..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -Suggest features in the Mattermost feature idea forum so it can be discussed, upvoted and considered for a [help wanted ticket](https://docs.mattermost.com/process/help-wanted.html). - -https://mattermost.com/suggestions/ diff --git a/.github/ISSUE_TEMPLATE/troubleshooting-question.md b/.github/ISSUE_TEMPLATE/troubleshooting-question.md deleted file mode 100644 index 550f8106..00000000 --- a/.github/ISSUE_TEMPLATE/troubleshooting-question.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -name: Troubleshooting question -about: Ask a question to solve installation and configuration issues - ---- - -For troubleshooting, see [https://docs.mattermost.com/install/troubleshooting.html](https://docs.mattermost.com/install/troubleshooting.html). diff --git a/.github/ISSUE_TEMPLATE/upgrade-dependencies.md b/.github/ISSUE_TEMPLATE/upgrade-dependencies.md deleted file mode 100644 index 48bb3581..00000000 --- a/.github/ISSUE_TEMPLATE/upgrade-dependencies.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Upgrade dependencies -about: A checklist to upgrade dependencies after cutting release - ---- - -### package.json - -#### Electron -- [ ] Electron and Spectron -- [ ] electron-builder - -#### Build tools -- [ ] Babel -- [ ] Webpack - -#### Test tools -- [ ] ESLint -- [ ] Other test tools - -#### Others -- [ ] Other devDependencies - -### src/package.json - -#### React -- [ ] React -- [ ] React-Bootstrap - -#### Others -- [ ] Other dependencies diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 5264ab79..00000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,41 +0,0 @@ -I confirm (by marking "x" in the [ ] below: [x]): - -- [ ] This is not a troubleshooting question. If you have having issues, please send us a message in the [Peer-to-peer Help](https://community-daily.mattermost.com/core/channels/peer-to-peer-help) or the [Developers: Desktop App](https://community-daily.mattermost.com/core/channels/desktop-app) channels on the Mattermost Community server -- [ ] I have read [contributing guidelines](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md). - ---- - -**Summary** - - -**Steps to reproduce** - - - -**Expected behavior** - -**Observed behavior** - - - -**Possible fixes** - - - ---- - -[JIRA tickets](https://mattermost.atlassian.net/issues/?filter=-4&jql=component%20%3D%20%22Desktop%20App%22%20order%20by%20created%20DESC) are created for all valid bug reports filed here. Bugs and features that the Mattermost core team are not immediately working on are opened as [Help Wanted GitHub issues](https://developers.mattermost.com/contribute/getting-started/contribution-checklist/) and welcome to contributions. - -Our goal is to bring the Mattermost desktop repository into our day-to-day internal process with the hope of having more frequent desktop releases with faster feature development and turnaround time on bug fixes. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0f134e5e..00000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,22 +0,0 @@ -Before submitting, please confirm you've - - [ ] read and understood our [Contributing Guidelines](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md) - - [ ] completed [Mattermost Contributor Agreement](https://mattermost.com/contribute/) - - [ ] executed `npm run lint:js` for proper code formatting - - [ ] executed `npm run check-types` for proper type checking - - [ ] executed `npm run test` to ensure all automated tests pass - -Please provide the following information: - -**Summary** - - -**Issue link** - - -**Test Cases** - -**Additional Notes**