add issue and PR templates

This commit is contained in:
Larry Ruane 2020-05-27 12:53:24 -06:00 committed by Larry Ruane
parent b47c0ddf99
commit 37c0ea54fe
4 changed files with 102 additions and 0 deletions

58
.github/ISSUE_TEMPLATE/bug-report.md vendored Normal file
View File

@ -0,0 +1,58 @@
---
name: Bug report
about: Create a report about a bug in lightwalletd.
title: ''
labels: 'bug'
assignees: ''
---
<!--
This issue tracker is only for technical issues related to lightwalletd.
General Zcash questions and/or support requests and are best directed to the
Zcash Forum: https://forum.zcashcommunity.com/
For reporting security vulnerabilities or for sensitive discussions with our
security team, please email security@z.cash . You can use this GPG key to send
an encrypted message:
https://z.cash/gpg-pubkeys/security.asc
fingerprint: AF85 0445 546C 18B7 86F9 2C62 88FB 8B86 D8B5 A68C
The key and fingerprint are duplicated on our Public Keys page:
https://z.cash/support/pubkeys.html
-->
### Describe the issue
Please provide a general summary of the issue you're experiencing
### Can you reliably reproduce the issue?
#### If so, please list the steps to reproduce below:
1.
2.
3.
### Expected behaviour
Tell us what should happen
### Actual behaviour + errors
Tell us what happens instead including any noticable error output (any messages
displayed on-screen when e.g. a crash occurred)
### The version of Zcash you were using:
Run `lightwalletd --version` to find out
### Machine specs:
- OS name + version:
- CPU:
- RAM:
- Disk size:
- Disk Type (HD/SDD):
- Linux kernel version (uname -a):
- Compiler version (run `go version`):
### Any extra information that might be useful in the debugging process.
This includes the relevant contents of `server.log`. You can paste raw
text, attach the file directly in the issue or link to the text via a pastebin
type site. Please also include any non-standard things you did during
compilation (extra flags, dependency version changes etc.) if applicable.

View File

@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest an idea for lightwalletd.
title: ''
labels: 'use case'
assignees: ''
---
## Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Example: I'm always
frustrated when [...]
## Describe the solution you'd like
A clear and concise description of what you want to happen.
## Alternatives you've considered
A clear and concise description of any alternative solutions or features you've
considered.
## Additional context
Add any other context or screenshots about the feature request here.

17
.github/ISSUE_TEMPLATE/ux-report.md vendored Normal file
View File

@ -0,0 +1,17 @@
---
name: UX report
about: Was lightwalletd hard to use? It's not you, it's us. We want to hear about it.
title: 'UX: '
labels: 'usability'
assignees: ''
---
<!-- Did lightwalletd not do what you expected?
Was it hard to figure out how to do something?
Could an error message be more helpful?
It's not you, it's us. We want to hear about it. -->
## What were you trying to do
## What happened

5
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,5 @@
Please ensure this checklist is followed for any pull requests for this repo. This checklist must be checked by both the PR creator and by anyone who reviews the PR.
* [ ] Relevant documentation for this PR has to be completed and reviewed by @lindanlee before the PR can be merged
* [ ] A test plan for the PR must be documented in the PR notes and included in the test plan for the next regular release
As a note, all CI tests need to be passing and all appropriate code reviews need to be done before this PR can be merged