Skip to content

Commit 6b36b9b

Browse files
authored
Add issue templates (#166)
1 parent 61d192e commit 6b36b9b

File tree

4 files changed

+134
-0
lines changed

4 files changed

+134
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Bug Report
2+
description: Report broken or incorrect behaviour
3+
labels: ["bug", "investigation needed"]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
Thanks for taking the time to fill out a bug report!
10+
11+
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.
12+
13+
- type: input
14+
attributes:
15+
label: Summary
16+
description: A simple summary of your bug report
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
attributes:
22+
label: Reproduction Steps
23+
description: >
24+
What you did to make it happen.
25+
Ideally there should be a short code snippet in this section to help reproduce the bug.
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
attributes:
31+
label: Expected Results
32+
description: >
33+
What did you expect to happen?
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
attributes:
39+
label: Actual Results
40+
description: >
41+
What actually happened?
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
attributes:
47+
label: System Information
48+
description: >
49+
Paste the result of `protoc --version; python --version; pip show betterproto` below.
50+
validations:
51+
required: true
52+
53+
- type: checkboxes
54+
attributes:
55+
label: Checklist
56+
options:
57+
- label: I have searched the issues for duplicates.
58+
required: true
59+
- label: I have shown the entire traceback, if possible.
60+
required: true
61+
- 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.
62+
required: true
63+

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
name:
2+
description:
3+
contact_links:
4+
- name: For questions about the library
5+
about: Support questions are better answered in our Slack group.
6+
url: https://join.slack.com/t/betterproto/shared_invite/zt-f0n0uolx-iN8gBNrkPxtKHTLpG3o1OQ
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Feature Request
2+
description: Suggest a feature for this library
3+
labels: ["enhancement"]
4+
5+
body:
6+
- type: input
7+
attributes:
8+
label: Summary
9+
description: >
10+
What problem is your feature trying to solve? What would become easier or possible if feature was implemented?
11+
validations:
12+
required: true
13+
14+
- type: dropdown
15+
attributes:
16+
multiple: false
17+
label: What is the feature request for?
18+
options:
19+
- The core library
20+
- RPC handling
21+
- The documentation
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
attributes:
27+
label: The Problem
28+
description: >
29+
What problem is your feature trying to solve?
30+
What would become easier or possible if feature was implemented?
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
attributes:
36+
label: The Ideal Solution
37+
description: >
38+
What is your ideal solution to the problem?
39+
What would you like this feature to do?
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
attributes:
45+
label: The Current Solution
46+
description: >
47+
What is the current solution to the problem, if any?
48+
validations:
49+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Summary
2+
3+
<!-- What is this pull request for? Does it fix any issues? -->
4+
5+
## Checklist
6+
7+
<!-- Put an x inside [ ] to check it, like so: [x] -->
8+
9+
- [ ] If code changes were made then they have been tested.
10+
- [ ] I have updated the documentation to reflect the changes.
11+
- [ ] This PR fixes an issue.
12+
- [ ] This PR adds something new (e.g. new method or parameters).
13+
- [ ] This change has an associated test.
14+
- [ ] This PR is a breaking change (e.g. methods or parameters removed/renamed)
15+
- [ ] This PR is **not** a code change (e.g. documentation, README, ...)
16+

0 commit comments

Comments
 (0)