From 145624d026134b847424a8b94853841db9df7568 Mon Sep 17 00:00:00 2001 From: Bobinson Bobby Date: Tue, 3 Sep 2019 11:38:05 +0530 Subject: [PATCH] github issue templates build, feature, issue templates --- .github/ISSUE_TEMPLATE/build_error.md | 42 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 43 +++++++++++++++++++++++ 2 files changed, 85 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/build_error.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/build_error.md b/.github/ISSUE_TEMPLATE/build_error.md new file mode 100644 index 00000000..0cb30e36 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/build_error.md @@ -0,0 +1,42 @@ +--- +name: Build Error +about: Create a detailed report about an error encountered during the Peerplays build process. + +--- + +**Instructions** +Please include a detailed Title above. Next, please complete the following sections below: +* Build Error +* Build Environment +* Steps To Reproduce +* Console Logs (optional) + +Finally, press the 'Submit new issue' button. The developers/PBSA Team will evaluate and prioritize your Bug Report for future development. + +**Build Error Description** +A clear and concise description of what the build error is. + +**Build Environment** +Details about the build environment, including the relevant required libraries. Much of this information can be found in the `CMakeFiles/CMakeOutput.log`. + - Host OS: [e.g. Ubuntu 18.04 LTS] + - Host Physical RAM [e.g. 4GB] + - Source Branch/Tag: [e.g. master or 2.0.180425] + - OpenSSL Version: [e.g. 1.1.0g] + - Boost Version: [e.g. 1.65.1] + - C++ Compiler: [e.g. gcc version 4.8.5] + +**Steps To Reproduce** +Steps to reproduce the behavior (example outlined below): +1. Using installation guide from this URL... +2. This is my complete build script... +3. It fails at this step with the following output... +4. See the error in the console log below... + +**Console Logs (optional)** +Please provide the full console log, including all commands entered and their output. This will allow detailed troubleshooting. + +## CORE TEAM TASK LIST +- [ ] Evaluate `Build Error` +- [ ] Provide build guidance +- [ ] Create `Bug Report` + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..91dbefc7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,43 @@ +--- +name: Feature Request +about: Suggest an idea for the Peerplays Community & PBSA Team to evaluate and prioritize for development. + +--- + +**Instructions** +Please include a detailed Title above. Next, please complete the following sections below: +* User Story +* Impacts +* Additional Context (optional) + +Finally, press the 'Submit new issue' button. The Core Team will evaluate and prioritize your Feature Request for future development. + +**User Story** +Please tell us about your feature request using the User Story format: +As a `` I want `` so that ``. + +At minimum, please define the ``, `` and `` for your feature request. The `` may be the system software, a component thereof, the end user, etc.; please be specific describing the context. The `` details the solution your feature will provide; please describe the process flow for the functionality. The `` details the benefits the feature will deliver; consider referencing alternative implementations for context. + +**Impacts** +Describe which portion(s) of Peerplays that may be impacted by your request. 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) + +**Additional Context (optional)** +Add any other context about your request here. + +## Community / PBSA check list +- [ ] Evaluate / Prioritize Feature Request +- [ ] Refine User Stories / Requirements +- [ ] Define Test Cases +- [ ] Design / Develop Solution +- [ ] Perform QA/Testing +- [ ] Update Documentation