Add issue templates (#166)
This commit is contained in:
parent
61d192e207
commit
6b36b9ba9f
63
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
63
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
name: Bug Report
|
||||||
|
description: Report broken or incorrect behaviour
|
||||||
|
labels: ["bug", "investigation needed"]
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: >
|
||||||
|
Thanks for taking the time to fill out a bug report!
|
||||||
|
|
||||||
|
If you're not sure it's a bug and you just have a question, the [community Slack channel](https://join.slack.com/t/betterproto/shared_invite/zt-f0n0uolx-iN8gBNrkPxtKHTLpG3o1OQ) is a better place for general questions than a GitHub issue.
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Summary
|
||||||
|
description: A simple summary of your bug report
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Reproduction Steps
|
||||||
|
description: >
|
||||||
|
What you did to make it happen.
|
||||||
|
Ideally there should be a short code snippet in this section to help reproduce the bug.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Expected Results
|
||||||
|
description: >
|
||||||
|
What did you expect to happen?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Actual Results
|
||||||
|
description: >
|
||||||
|
What actually happened?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: System Information
|
||||||
|
description: >
|
||||||
|
Paste the result of `protoc --version; python --version; pip show betterproto` below.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Checklist
|
||||||
|
options:
|
||||||
|
- label: I have searched the issues for duplicates.
|
||||||
|
required: true
|
||||||
|
- label: I have shown the entire traceback, if possible.
|
||||||
|
required: true
|
||||||
|
- label: I have verified this issue occurs on the latest prelease of betterproto which can be installed using `pip install -U --pre betterproto`, if possible.
|
||||||
|
required: true
|
||||||
|
|
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
name:
|
||||||
|
description:
|
||||||
|
contact_links:
|
||||||
|
- name: For questions about the library
|
||||||
|
about: Support questions are better answered in our Slack group.
|
||||||
|
url: https://join.slack.com/t/betterproto/shared_invite/zt-f0n0uolx-iN8gBNrkPxtKHTLpG3o1OQ
|
49
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
49
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
name: Feature Request
|
||||||
|
description: Suggest a feature for this library
|
||||||
|
labels: ["enhancement"]
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Summary
|
||||||
|
description: >
|
||||||
|
What problem is your feature trying to solve? What would become easier or possible if feature was implemented?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
multiple: false
|
||||||
|
label: What is the feature request for?
|
||||||
|
options:
|
||||||
|
- The core library
|
||||||
|
- RPC handling
|
||||||
|
- The documentation
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: The Problem
|
||||||
|
description: >
|
||||||
|
What problem is your feature trying to solve?
|
||||||
|
What would become easier or possible if feature was implemented?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: The Ideal Solution
|
||||||
|
description: >
|
||||||
|
What is your ideal solution to the problem?
|
||||||
|
What would you like this feature to do?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: The Current Solution
|
||||||
|
description: >
|
||||||
|
What is the current solution to the problem, if any?
|
||||||
|
validations:
|
||||||
|
required: false
|
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
## Summary
|
||||||
|
|
||||||
|
<!-- What is this pull request for? Does it fix any issues? -->
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
<!-- Put an x inside [ ] to check it, like so: [x] -->
|
||||||
|
|
||||||
|
- [ ] If code changes were made then they have been tested.
|
||||||
|
- [ ] I have updated the documentation to reflect the changes.
|
||||||
|
- [ ] This PR fixes an issue.
|
||||||
|
- [ ] This PR adds something new (e.g. new method or parameters).
|
||||||
|
- [ ] This change has an associated test.
|
||||||
|
- [ ] This PR is a breaking change (e.g. methods or parameters removed/renamed)
|
||||||
|
- [ ] This PR is **not** a code change (e.g. documentation, README, ...)
|
||||||
|
|
Loading…
x
Reference in New Issue
Block a user