From b525a3629307796f12a2d4d6fa91276960ddefcd Mon Sep 17 00:00:00 2001 From: Alex Waibel Date: Wed, 16 Mar 2022 15:09:11 -0700 Subject: [PATCH 1/3] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 81 ++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..d8244408 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,81 @@ +--- +name: Bug report +about: How to report bugs +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 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. + +===================== +First and foremost, thank you for your interest in making qFlipper better by reporting bugs! + +**Describe the bug** +What were you trying to do? + +**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. + +**Actual behavior** +A clear and concise description of what happened instead. + +**Additional troubleshooting** +1. Does the issue persist if you try multiple times? +2. Does reconnecting/rebooting Flipper solve it? + +**The report *must* also include at least one of the following:** +1. A **FULL LOG** of this application run. (see below). +2. A screenshot of the application window (if it is a graphical issue). + +**Additional context** +You are free to add any other context about the problem you deem helpful here. + +## IMPORTANT - Getting the full log +Normally, the application log is shown upon pressing the "LOGS" button in the bottom left corner of the window. +Despite it having some value already, there is a more detailed version saved each time qFlipper is run. +In order to access it, follow these steps: +1. Click the "LOGS" button to open the log window. +2. Right click on the log window. +3. In the context menu, select "Browse all logs...". +4. A folder containing several log files should open. +5. Find the most recent file, this is it! + +**Warning!** The log will contain your Flipper's unique name. If you wish not to disclose it, search/replace +all its occurrences before attaching the file. From b32d946878cfaa38a2a9aade21ce14978cdd887d Mon Sep 17 00:00:00 2001 From: Alex Waibel Date: Wed, 16 Mar 2022 15:10:16 -0700 Subject: [PATCH 2/3] Remove leftover template --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ---------------------------- 1 file changed, 32 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d8244408..ef9b1035 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,38 +6,6 @@ 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 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. - -===================== First and foremost, thank you for your interest in making qFlipper better by reporting bugs! **Describe the bug** From 7387effdffca65294710fa966f9b64503c7c6b89 Mon Sep 17 00:00:00 2001 From: Alex Waibel Date: Wed, 16 Mar 2022 15:12:56 -0700 Subject: [PATCH 3/3] Remove old bug template --- BUGS.md | 29 ----------------------------- 1 file changed, 29 deletions(-) delete mode 100644 BUGS.md diff --git a/BUGS.md b/BUGS.md deleted file mode 100644 index 8c73ea34..00000000 --- a/BUGS.md +++ /dev/null @@ -1,29 +0,0 @@ -# How to report bugs -First and foremost, thank you for your interest in making qFlipper better by reporting bugs! - -## Bug report example -A well put together bug report should answer the following questions: -1. What were you trying to do? -2. What results were you expecting to get? -3. What is actually happening instead? -4. Does the issue persist if you try multiple times? -5. Does reconnecting/rebooting Flipper solve it? - -The report *must* also include at least one of the following: -1. A **FULL LOG** of this application run. (see below). -2. A screenshot of the application window (if it is a graphical issue). - -You are free to add any other information you deem helpful. - -## IMPORTANT - Getting the full log -Normally, the application log is shown upon pressing the "LOGS" button in the bottom left corner of the window. -Despite it having some value already, there is a more detailed version saved each time qFlipper is run. -In order to access it, follow these steps: -1. Click the "LOGS" button to open the log window. -2. Right click on the log window. -3. In the context menu, select "Browse all logs...". -4. A folder containing several log files should open. -5. Find the most recent file, this is it! - -**Warning!** The log will contain your Flipper's unique name. If you wish not to disclose it, search/replace -all its occurences before attaching the file.