Table of Contents
Everybody’s time and efforts are valuable. With just a couple moments of extra time to flesh out some details regarding a bug report, usability issue, or even a feature request, you’ll get results much faster, and help keep the project humming along. It’s understood that you might not always have time to do so. Just know that this is appreciated, that any little extra information you can provide will always help and will feed back to you in great dividend in the long run. This is a common theme as software continues to play a larger role in our lives, and as the pace and complexity of software development ramp up.
You are encouraged to report your items directly to the repository (github for example). Benefit multiplies when you do.
References
Issue reporting guidelines are becoming more common too. See examples here:
- https://github.com/git-for-windows/git/wiki/Issue-reporting-guidelines
- https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines
Basic Issue Template
- Operating System (including the version)
- Software version
- Development snapshot commit version (short commit version is fine)
- Release version
- Steps to Reproduce
- For example, what buttons are you clicking?
- What clicks have you made to get the point where behavior is undesired?
- Can you provide screenshots?
- What is your hardware setup?
- For example, what buttons are you clicking?
- Customizations: Examples
- Have you used any functions to copy shipped customizable files to a local working directory, and then customized them? Or is this straight-out-of-the-box release behavior, right from launch?
- Are you in development mode and have you customized any files that get loaded to define options, buttons, etc.?
- Log Output:
- Copy and paste the log output, all of it if you can. If this is an NodeJs Electron App, like Dacqman, you can see the console by toggling development tools using the menu item or keyboard shortcut Command+i (Mac) or Ctrl-i (Win32/etc)
- Screenshots are fine too.