Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update templates #87

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 31 additions & 11 deletions BUGS.md → .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,39 @@
# How to report bugs
---
name: Bug report
about: How to report bugs
title: ''
labels: bug
assignees: ''

---
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?
**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:
**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.
**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.
Expand All @@ -26,4 +46,4 @@ In order to access it, follow these steps:
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.
all its occurrences before attaching the file.