- *_Epistemic status:_ #budding [[Software Bug]] reports when approached correctly make software into a more reliable product by aiding developers with clear and detailed documentation to be able to classify, investigate, and solve the problem. ## Guidelines on creating a software bug report You should include the following for each [[Software Bug]]: ### Title A descriptive title that properly reflects the issue. If the [[Software Bug]] has been reported previously, having a name that reflects the issue makes it easier to locate. ### Severity See [[Severity in Software]]. ### Summary A brief abstract of what the [[Software Bug]] is, and its impact in the system. ### Reproduction Steps Step by step detailed guideline that allows anybody to reproduce the [[Software Bug]]. ### Logs Logs document events in a system that can be invaluable to see why a workload or software failed and what happened before it did. ### Screenshots and documents Screenshots not only proves the [[Software Bug]] exists, but the developer could get an idea of why it is happening. This is particularly useful with UI issues where an element could have the incorrect display. ### Metadata Details on how and with what the [[Software Bug]] was reproduced that could be useful in the investigation. The following are examples of some you can use: - Software version - OS with the version - Browser with the version - Software dependencies with their version - Time and day when it was reproduced - etc ### Mitigation Not a specifically required field to include, but if you know how to solve the [[Software Bug]] it would make the process easier for the developers to include that information. --- ## References - LookFar. “Defining Priority and Severity: How to Classify and Approach Product Issues,” February 9, 2017. <https://www.lookfar.com/blog/2017/02/09/priority-and-severity-how-to-classify-and-approach-product-issues/>. - HackerOne. “Introduction.” Hacker101. Accessed June 28, 2022. <https://www.hacker101.com/sessions/introduction.html>. - SearchSoftwareQuality. “How to Write a Good Software Bug Report.” Accessed June 28, 2022. <https://www.techtarget.com/searchsoftwarequality/tip/How-to-write-a-good-software-bug-report>. - Thomas, David, and Andrew Hunt. _The Pragmatic Programmer, 20th Anniversary Edition: Journey to Mastery_. Second edition. Boston: Addison-Wesley, 2019.