Skip to content

Commit 53d750e

Browse files
authored
chore: add github templates (algolia#47)
1 parent 8a86dc0 commit 53d750e

File tree

3 files changed

+76
-0
lines changed

3 files changed

+76
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve our libraries
4+
5+
---
6+
7+
<!--
8+
Thanks for participating in this project! We will try to answer as soon as possible 🙏
9+
-->
10+
11+
**Describe the bug 🐛**
12+
A clear and concise description of what the bug is.
13+
14+
**To Reproduce 🔍**
15+
Steps to reproduce the behavior:
16+
17+
1. Go to '...'
18+
2. Click on '....'
19+
3. Scroll down to '....'
20+
4. See error
21+
22+
**Expected behavior 💭**
23+
A clear and concise description of what you expected to happen.
24+
25+
**Screenshots 🖥**
26+
If applicable, add screenshots to help explain your problem.
27+
28+
**Environment:**
29+
30+
- OS: [e.g. iOS, android, web]
31+
- Library Version [e.g. 1.1.0]
32+
33+
**Additional context**
34+
Add any other context about the problem here.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
<!--
8+
Thanks for participating in this project! We will try to answer as soon as possible 🙏
9+
-->
10+
11+
**Is your feature request related to a problem? Please describe 🙏**
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
14+
**Describe the solution you'd like 🤔**
15+
A clear and concise description of what you want to happen.
16+
17+
**Describe alternatives you've considered ✨**
18+
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
**Additional context**
21+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
| Q | A |
2+
|-----------------|----------|
3+
| Bug fix? | yes/no |
4+
| New feature? | yes/no |
5+
| BC breaks? | no |
6+
| Related Issue | Fix #... |
7+
| Need Doc update | yes/no |
8+
9+
## Describe your change
10+
11+
<!--
12+
Please describe your change, add as much detail as
13+
necessary to understand your code.
14+
-->
15+
16+
## What problem is this fixing?
17+
18+
<!--
19+
Please include everything needed to understand the problem,
20+
its context and consequences, and, if possible, how to recreate it.
21+
-->

0 commit comments

Comments
 (0)