diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea78..0b750200 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,33 +6,63 @@ labels: '' assignees: '' --- +**Instructions** +Please include a detailed Title above. Next, please complete the following sections below: +* Bug Description +* Impacts +* Steps To Reproduce +* Expected Behavior +* Screenshots (optional) +* Host Environment (optional) +* Additional Context (optional) -**Describe the bug** +Finally, press the 'Submit new issue' button. The Core Team will evaluate and prioritize your Bug Report for future development. + +**Bug Description** A clear and concise description of what the bug is. -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +**Impacts** +Describe which portion(s) of Peerplays may be impacted by this bug. Please tick at least one box. +- [ ] API (the application programming interface) +- [ ] Build (the build process or something prior to compiled code) +- [ ] CLI (the command line wallet) +- [ ] Deployment (the deployment process after building such as Docker, Gitlab, etc.) +- [ ] P2P (the peer-to-peer network for transaction/block propagation) +- [ ] Performance (system or user efficiency, etc.) +- [ ] Protocol (the blockchain logic, consensus, validation, etc.) +- [ ] Security (the security of system or user data, etc.) +- [ ] UX (the User Experience) +- [ ] Other (please add below) -**Expected behavior** +**Steps To Reproduce** +Steps to reproduce the behavior (example outlined below): +1. Execute API call '...' +2. Using JSON payload '...' +3. Received response '...' +4. See error in screenshot + +**Expected Behavior** A clear and concise description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. +**Screenshots (optional)** +If applicable, add screenshots to help explain process flow and behavior. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** +**Host Environment** +Please provide details about the host environment. Much of this information can be found running: `witness_node --version`. + - Host OS: [e.g. Ubuntu 18.04 LTS] + - Host Physical RAM [e.g. 4GB] + - Peerplays Version + - OpenSSL Version: [e.g. 1.1.0g] + - Boost Version: [e.g. 1.67.0] + +**Additional Context (optional)** Add any other context about the problem here. + +## PBSA / Developer tasks + +- [ ] Evaluate / Prioritize Bug Report +- [ ] Refine User Stories / Requirements +- [ ] Define Test Cases +- [ ] Design / Develop Solution +- [ ] Perform QA/Testing +- [ ] Update Documentation