{"id":438,"date":"2020-05-04T23:23:29","date_gmt":"2020-05-04T23:23:29","guid":{"rendered":"https:\/\/oshablue.com\/bsides\/?p=438"},"modified":"2020-06-01T19:51:53","modified_gmt":"2020-06-01T19:51:53","slug":"ideas-for-bug-reporting","status":"publish","type":"post","link":"https:\/\/oshablue.com\/doc\/ideas-for-bug-reporting\/","title":{"rendered":"Ideas for Bug Reporting"},"content":{"rendered":"<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_68 counter-hierarchy ez-toc-counter ez-toc-light-blue ez-toc-container-direction\">\n<p class=\"ez-toc-title\">Table of Contents<\/p>\n<label for=\"ez-toc-cssicon-toggle-item-69ea59894bec8\" class=\"ez-toc-cssicon-toggle-label\"><span class=\"\"><span class=\"eztoc-hide\" style=\"display:none;\">Toggle<\/span><span class=\"ez-toc-icon-toggle-span\"><svg style=\"fill: #999;color:#999\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" class=\"list-377408\" width=\"20px\" height=\"20px\" viewBox=\"0 0 24 24\" fill=\"none\"><path d=\"M6 6H4v2h2V6zm14 0H8v2h12V6zM4 11h2v2H4v-2zm16 0H8v2h12v-2zM4 16h2v2H4v-2zm16 0H8v2h12v-2z\" fill=\"currentColor\"><\/path><\/svg><svg style=\"fill: #999;color:#999\" class=\"arrow-unsorted-368013\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"10px\" height=\"10px\" viewBox=\"0 0 24 24\" version=\"1.2\" baseProfile=\"tiny\"><path d=\"M18.2 9.3l-6.2-6.3-6.2 6.3c-.2.2-.3.4-.3.7s.1.5.3.7c.2.2.4.3.7.3h11c.3 0 .5-.1.7-.3.2-.2.3-.5.3-.7s-.1-.5-.3-.7zM5.8 14.7l6.2 6.3 6.2-6.3c.2-.2.3-.5.3-.7s-.1-.5-.3-.7c-.2-.2-.4-.3-.7-.3h-11c-.3 0-.5.1-.7.3-.2.2-.3.5-.3.7s.1.5.3.7z\"\/><\/svg><\/span><\/span><\/label><input type=\"checkbox\"  id=\"ez-toc-cssicon-toggle-item-69ea59894bec8\"  aria-label=\"Toggle\" \/><nav><ul class='ez-toc-list ez-toc-list-level-1 ' ><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/oshablue.com\/doc\/ideas-for-bug-reporting\/#References\" title=\"References\">References<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/oshablue.com\/doc\/ideas-for-bug-reporting\/#Basic_Issue_Template\" title=\"Basic Issue Template\">Basic Issue Template<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-3\" href=\"https:\/\/oshablue.com\/doc\/ideas-for-bug-reporting\/#Thanks\" title=\"Thanks!\">Thanks!<\/a><\/li><\/ul><\/nav><\/div>\n\n<p>Everybody&#8217;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&#8217;ll get results much faster, and help keep the project humming along.  It&#8217;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.<\/p>\n\n\n\n<p>You are encouraged to report your items directly to the repository (github for example).  Benefit multiplies when you do.<\/p>\n\n\n\n<!--more-->\n\n\n\n<h3 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"References\"><\/span>References<span class=\"ez-toc-section-end\"><\/span><\/h3>\n\n\n\n<p>Issue reporting guidelines are becoming more common too.  See examples here:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><a rel=\"noreferrer noopener\" href=\"https:\/\/github.com\/git-for-windows\/git\/wiki\/Issue-reporting-guidelines\" target=\"_blank\">https:\/\/github.com\/git-for-windows\/git\/wiki\/Issue-reporting-guidelines<\/a><\/li><li><a rel=\"noreferrer noopener\" href=\"https:\/\/developer.mozilla.org\/en-US\/docs\/Mozilla\/QA\/Bug_writing_guidelines\" target=\"_blank\">https:\/\/developer.mozilla.org\/en-US\/docs\/Mozilla\/QA\/Bug_writing_guidelines<\/a><\/li><\/ul>\n\n\n\n<h3 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Basic_Issue_Template\"><\/span>Basic Issue Template<span class=\"ez-toc-section-end\"><\/span><\/h3>\n\n\n\n<ul class=\"wp-block-list\"><li>Operating System (including the version)<\/li><li>Software version<ul><li>Development snapshot commit version (short commit version is fine)<\/li><li>Release version<\/li><\/ul><\/li><li>Steps to Reproduce<ul><li>For example, what buttons are you clicking?  <ul><li>What clicks have you made to get the point where behavior is undesired?<\/li><li>Can you provide screenshots?<\/li><\/ul><\/li><li>What is your hardware setup?<\/li><\/ul><\/li><li>Customizations: Examples<ul><li>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?<\/li><li>Are you in development mode and have you customized any files that get loaded to define options, buttons, etc.?<\/li><\/ul><\/li><li>Log Output:<ul><li>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)<\/li><li>Screenshots are fine too.<\/li><\/ul><\/li><\/ul>\n\n\n\n<h3 class=\"wp-block-heading\"><span class=\"ez-toc-section\" id=\"Thanks\"><\/span>Thanks!<span class=\"ez-toc-section-end\"><\/span><\/h3>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Everybody&#8217;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&#8217;ll get results much faster, and help keep the project humming along. It&#8217;s understood that you might not always have time to do so. Just &hellip; <\/p>\n<p class=\"link-more\"><a href=\"https:\/\/oshablue.com\/doc\/ideas-for-bug-reporting\/\" class=\"more-link\">Continue reading<span class=\"screen-reader-text\"> &#8220;Ideas for Bug Reporting&#8221;<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[39,36,3,37,14,29,38,35],"tags":[],"class_list":["post-438","post","type-post","status-publish","format-standard","hentry","category-best-practices","category-bug-reporting","category-hmi-people-and-tech","category-issues","category-new-prototypes","category-quick-hint-how-tos-and-reminders","category-software","category-troubleshooting","entry"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/oshablue.com\/doc\/wp-json\/wp\/v2\/posts\/438","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oshablue.com\/doc\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/oshablue.com\/doc\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/oshablue.com\/doc\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/oshablue.com\/doc\/wp-json\/wp\/v2\/comments?post=438"}],"version-history":[{"count":3,"href":"https:\/\/oshablue.com\/doc\/wp-json\/wp\/v2\/posts\/438\/revisions"}],"predecessor-version":[{"id":488,"href":"https:\/\/oshablue.com\/doc\/wp-json\/wp\/v2\/posts\/438\/revisions\/488"}],"wp:attachment":[{"href":"https:\/\/oshablue.com\/doc\/wp-json\/wp\/v2\/media?parent=438"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oshablue.com\/doc\/wp-json\/wp\/v2\/categories?post=438"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oshablue.com\/doc\/wp-json\/wp\/v2\/tags?post=438"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}