Merge pull request #103 from peerplays-network/github-issue-template1
Update issue & PR templates
This commit is contained in:
commit
1d7e4fc630
4 changed files with 201 additions and 0 deletions
80
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
80
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,80 @@
|
||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
title: ''
|
||||||
|
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)
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
**Porting from Bitshares or other Graphene forks**
|
||||||
|
|
||||||
|
Corresponding issues:
|
||||||
|
|
||||||
|
- [FILL in issue1]
|
||||||
|
- [FILL in any other detail]
|
||||||
|
|
||||||
|
Corresponding PR:
|
||||||
|
|
||||||
|
- [fill in corresponding PR link]
|
||||||
|
|
||||||
|
**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)
|
||||||
|
|
||||||
|
|
||||||
|
**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 (optional)**
|
||||||
|
If applicable, add screenshots to help explain process flow and behavior.
|
||||||
|
|
||||||
|
**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
|
||||||
42
.github/ISSUE_TEMPLATE/build_error.md
vendored
Normal file
42
.github/ISSUE_TEMPLATE/build_error.md
vendored
Normal file
|
|
@ -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
|
||||||
|
- [ ] <OR> Create `Bug Report`
|
||||||
|
|
||||||
43
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
43
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -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 `<persona>` I want `<some functionality>` so that `<some benefit is realized>`.
|
||||||
|
|
||||||
|
At minimum, please define the `<who>`, `<what>` and `<why>` for your feature request. The `<who>` may be the system software, a component thereof, the end user, etc.; please be specific describing the context. The `<what>` details the solution your feature will provide; please describe the process flow for the functionality. The `<why>` 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
|
||||||
36
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
36
.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
Please Note:
|
||||||
|
|
||||||
|
|
||||||
|
1. PRs will be reviewed from oldest to newest
|
||||||
|
2. PRs should use PR template in order to be considered for review.
|
||||||
|
3. PRs that do not have one of the PR template completely filled out with all declarations satisfied will not be reviewed.
|
||||||
|
|
||||||
|
|
||||||
|
### Purpose
|
||||||
|
|
||||||
|
(FILL ME IN) This section describes why this PR is here. Usually it would include a reference
|
||||||
|
to the tracking task that it is part or all of the solution for.
|
||||||
|
|
||||||
|
The Tracking issue is [Create the issue if non existent and fill in]
|
||||||
|
|
||||||
|
### Declarations
|
||||||
|
|
||||||
|
Check these if you believe they are true
|
||||||
|
|
||||||
|
- [ ] The code base is in a better state after this PR
|
||||||
|
- [ ] Is prepared according to the [Release Management & Versioning](https://github.com/peerplays-network/peerplays/wiki/Release-Management-&-Versioning)
|
||||||
|
- [ ] The level of testing this PR includes is appropriate
|
||||||
|
- [ ] All tests pass using the self-service CI/Gitlab. (TODO)
|
||||||
|
- [ ] Changes to the API is documented
|
||||||
|
- [ ] Testing steps for the QA team / community is shared
|
||||||
|
|
||||||
|
|
||||||
|
### Reviewers
|
||||||
|
|
||||||
|
(FILL ME IN) Reviewer 1 (If possible, assign the Reviewer for the PR)
|
||||||
|
|
||||||
|
(FILL ME IN, optional) Any additional notes to reviewers or testers.
|
||||||
|
|
||||||
|
### FYIs
|
||||||
|
|
||||||
|
(FILL ME IN, Optional) Names of anyone else you wish to be notified of
|
||||||
Loading…
Reference in a new issue