How To Report Issues » History » Version 20

Dan Smith, 12/07/2022 08:23 PM

1 17 Dan Smith
# How To Report Issues
2 1 Dan Smith
3 17 Dan Smith
## First things first!
4 1 Dan Smith
5 17 Dan Smith
Before you file a bug, *please test the latest Development Version of CHIRP to see if your issue has been fixed*. These builds are generated automatically every night when there is a change, and they are available from the bottom of the [download page](/projects/chirp/wiki/download).
6 7 Dan Smith
7 16 Dan Smith
Please *DO NOT* attach the manufacturer's software to the issue. Even if you think the software is freely available via download elsewhere, that does not mean you can legally distribute it yourself. Posting it here also opens up the CHIRP website and community to potential action by owners of that software. If it is downloadable somewhere, feel free to post a link but *DO NOT* attach it to the issue.
9 17 Dan Smith
## Effective Bug Reporting
10 2 Dan Smith
11 1 Dan Smith
Effective reporting of a bug or feature is critical to getting the issue resolved in a timely manner. If bug descriptions are difficult to understand or reproduce, they are less likely to receive attention. When you are crafting your bug report, try to answer the following questions:
1. What is the behavior you are seeing?
2. What is the behavior you were expecting?
3. Can you reproduce the problem all the time?
4. What are the steps required to reproduce the problem?
5. Is this specific to a certain radio model (driver) or something that you can reproduce with another radio?
19 13 Jens Jensen
In most cases, *it is important to attach an image of your radio to the bug* so that a developer can look at the exact state and determine what the problem is. It is often helpful describe what you expect to see in a given memory location, as well as what you actually see. If relevant or difficult to describe what you are seeing, attaching a screenshot of the behavior may also be helpful.
20 5 Dan Smith
21 18 Dan Smith
For more information about how to file an effective bug report, please see Eric S. Raymond's [How to ask questions the smart way](
22 10 Dan Smith
23 17 Dan Smith
## Getting your debug log
24 5 Dan Smith
25 13 Jens Jensen
If you are expecting something to happen (such as importing from a file, or setting a memory) and CHIRP appears to ignore the request, *you probably should include your debug.log*. If you are getting an error message, you should definitely include the log.
26 1 Dan Smith
27 9 Dan Smith
The debug log is cleared every time you start chirp, so the procedure for getting a usable log is:
1. Start chirp
2. Reproduce the failure or bug
3. Close chirp
4. Copy and send the debug.log before starting chirp again
Here are some tips for getting to it on the various platforms:
36 17 Dan Smith
### Windows
37 8 Dan Smith
38 20 Dan Smith
Go to Start->Run and type `%APPDATA%\CHIRP` (exactly as it is, including the percent signs). Your `debug.log` file will be in the folder that opens.
39 1 Dan Smith
40 17 Dan Smith
### Linux and MacOS
41 6 Dan Smith
42 1 Dan Smith
Your debug log should be in your home directory, in .chirp/debug.log.
If you don't know how to find this, open up a terminal window.
44 17 Dan Smith
(Mac: click on spotlight (the magnifying glass icon at top right corner), and type `terminal`)
45 11 Jens Jensen
46 15 Jens Jensen
Run the following command at the prompt:
47 11 Jens Jensen
48 17 Dan Smith
cp ~/.chirp/debug.log ~/Desktop
51 9 Dan Smith
Then close the terminal window. The debug.log file will be on your desktop.
53 7 Dan Smith
54 17 Dan Smith
## Filing your report
55 7 Dan Smith
56 17 Dan Smith
In order to file a new bug report or feature request, you must first create (or sign into) an account. Click the [Register]( or [Sign in]( link at the top right of this page to do that. Once you are logged in, click the [New issue]( link on the menu bar above to get started.