Skip to content

Commit 2587b37

Browse files
committed
chore: update pr and issue template
1 parent 6b398ad commit 2587b37

File tree

2 files changed

+76
-30
lines changed

2 files changed

+76
-30
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 70 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,73 @@
1-
<!--
2-
Please use this issue tracker only for reporting bugs or feature requests.
1+
name: Bug Report
2+
description: File a bug report.
3+
title: '[bug]: '
4+
labels: ['bug', 'triage']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Please help us help you!
310

4-
If you need support, please use:
5-
6-
- our community forum
7-
http://discourse.algolia.com
8-
9-
- StackOverflow with the `algolia` tag
10-
https://stackoverflow.com/questions/tagged/algolia
11+
Before filing your issue, ask yourself:
12+
- Is there an issue already opened for this bug?
13+
- Can I reproduce it?
1114

12-
-->
15+
If you are not sure about the origin of the issue, or if it impacts your customer experience, please contact [our support team](https://alg.li/support).
16+
- type: textarea
17+
attributes:
18+
label: Description
19+
description: A clear and concise description of what the bug is.
20+
validations:
21+
required: true
22+
- type: dropdown
23+
id: python version
24+
attributes:
25+
label: python version
26+
description: What is the Python version you've reproduced the error with
27+
options:
28+
- 3.8
29+
- 3.9
30+
- 3.10
31+
- 3.11
32+
- 3.12
33+
- 3.13
34+
validations:
35+
required: true
36+
- type: dropdown
37+
id: django version
38+
attributes:
39+
label: Django version
40+
description: What is the Django version you've reproduced the error with
41+
options:
42+
- 4.0
43+
- 4.1
44+
- 4.2
45+
- 5.0
46+
- 5.1
47+
validations:
48+
required: true
49+
- type: textarea
50+
attributes:
51+
label: Steps to reproduce
52+
description: Write down the steps to reproduce the bug, please include any information that seems relevant for us to reproduce it properly
53+
placeholder: |
54+
1. Use method `...`
55+
2. With parameters `...`
56+
3. See error
57+
validations:
58+
required: true
59+
- type: textarea
60+
id: logs
61+
attributes:
62+
label: Relevant log output
63+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
64+
render: shell
65+
- type: checkboxes
66+
attributes:
67+
label: Self-service
68+
description: |
69+
If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
70+
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
71+
options:
72+
- label: I'd be willing to fix this bug myself.
1373

14-
- Django version:
15-
- Algolia Django integration version:
16-
- Algolia Client Version: #.#.#
17-
- Language Version:
18-
19-
### Description
20-
21-
22-
### Steps To Reproduce

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,17 @@
1-
| Q | A
2-
| ----------------- | ----------
3-
| Bug fix? | yes/no
4-
| New feature? | yes/no <!-- please update the /CHANGELOG.md file -->
5-
| BC breaks? | no
6-
| Related Issue | Fix #... <!-- will close issue automatically, if any -->
7-
| Need Doc update | yes/no
1+
## 🧭 What and Why
82

3+
🎟 JIRA Ticket:
94

10-
## Describe your change
5+
### Changes included:
116

127
<!--
138
Please describe your change, add as much detail as
149
necessary to understand your code.
1510
-->
1611

17-
## What problem is this fixing?
12+
## 🧪 Test
1813

1914
<!--
20-
Please include everything needed to understand the problem,
21-
its context and consequences, and, if possible, how to recreate it.
15+
Please include detail that could help the maintainers of this repository
16+
to assert the changes you've made (e.g. written tests, scenarios).
2217
-->

0 commit comments

Comments
 (0)