Skip to content

Commit c9a966e

Browse files
committed
[GitHub] Add bug report and feature request issues
Provides a template for filling out information regarding an issue.
1 parent e52397c commit c9a966e

File tree

2 files changed

+153
-0
lines changed

2 files changed

+153
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Something is rotten in the state of Denmark... 🤔
4+
title: "[Describe the problem you encountered]"
5+
labels: kind/bug
6+
assignees: nvzqz
7+
8+
---
9+
10+
<!--
11+
Thank you for reporting a bug in Bay!
12+
13+
Please fill in as much of the template below as you're able. This helps us
14+
address and hopefully recreate the problems you're dealing with.
15+
-->
16+
17+
# 🐛 Bug Report
18+
19+
<!--
20+
Clearly and concisely describe what happened.
21+
-->
22+
23+
I did ...
24+
25+
I expected ... to happen.
26+
27+
Instead I got ...
28+
29+
## Steps to Reproduce
30+
31+
<!--
32+
Explain succinctly what steps need to be taken to reproduce.
33+
34+
If applicable, you may also upload images or videos to demonstrate this.
35+
36+
This section should be quick to look at. If you'd like to write about this issue
37+
in detail, use the "Detailed Description" section.
38+
-->
39+
40+
1. Go to ...
41+
2. Click on ...
42+
3. Scroll down to ...
43+
4. See ...
44+
45+
## Components Affected
46+
47+
<!--
48+
If known, list the affected Bay components.
49+
-->
50+
51+
<!-- For example: -->
52+
- Hasher
53+
54+
## Platforms Affected
55+
56+
<!--
57+
Fill out the details of the machines with which you've experienced this.
58+
59+
You can simply put:
60+
- macOS/Linux: The output of `uname -a`
61+
- Windows: The version and whether 32 or 64-bit
62+
-->
63+
64+
<!-- For example: -->
65+
Windows 7, 32-bit
66+
67+
## Detailed Description
68+
69+
<!--
70+
Use this space to write a longer description here than "Steps to Reproduce".
71+
-->
72+
73+
There is an issue where ... <!-- Short summary of the bug -->
74+
75+
I tried this code/command: ... <!-- Sample that causes the bug -->
76+
77+
I expected this to happen: ... <!-- What assumption is being violated? -->
78+
79+
Instead, this happened: ... <!-- The unexpected behavior experienced -->
80+
81+
## Relevant Issues
82+
83+
<!--
84+
Link any issues you feel are relevant to this bug.
85+
-->
86+
87+
Unknown
+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: 💡 Feature Request
3+
about: I have a suggestion (and may want to implement it)! 🙂
4+
title: "[Describe the feature you're proposing]"
5+
labels: kind/feature
6+
---
7+
8+
# 💡 Feature Request
9+
10+
<!--
11+
Explain in one paragraph what the feature is.
12+
-->
13+
14+
I have a dream that Bay will be able to ...
15+
16+
## Components
17+
18+
<!--
19+
Please specify the Bay components the new feature should be added to. Otherwise,
20+
delete this section.
21+
22+
If this feature is platform-specific, state the platforms and why the feature
23+
may not work on other platforms.
24+
-->
25+
26+
This would work on Bay's ...
27+
28+
## Motivation
29+
30+
<!--
31+
Why would we do this? Describe reasons to use this feature.
32+
33+
Describe the use case(s) or other motivation for the new feature.
34+
-->
35+
36+
We should do this because ...
37+
38+
## Proposal
39+
40+
<!--
41+
Describe how this feature might be implemented, and why. Add any considered
42+
drawbacks.
43+
-->
44+
45+
This can be achieved by ...
46+
47+
## Prior Art
48+
49+
<!--
50+
Discuss prior art, both the good and the bad, in relation to this proposal. A
51+
few examples of what this can include are:
52+
- What do similar systems (such as IPFS) do in this case?
53+
- How has this feature in previous works affect those projects?
54+
-->
55+
56+
If you take a look at ..., you'll see that it has ...
57+
58+
## Alternatives
59+
60+
<!--
61+
Are there other ways to solve this problem that you've considered? What are
62+
their potential drawbacks? Why was the proposed solution chosen over these
63+
alternatives?
64+
-->
65+
66+
We could also take the approach explained at ...

0 commit comments

Comments
 (0)