Skip to content
This repository was archived by the owner on Sep 9, 2026. It is now read-only.

Commit e177714

Browse files
samsjasamsja
authored
chore: add a better looking issue template (#1623)
Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
1 parent f7371b4 commit e177714

4 files changed

Lines changed: 208 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug-v1.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: 🐛 DocArray V1 Bug (0.1.0 - 0.20.1)
2+
description: Report a bug or unexpected behavior in DocArray version prior to v2 (0.21.1)
3+
labels: [bug V1, unconfirmed]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thank you for contributing to DocArray! 🙌
9+
10+
- type: markdown
11+
attributes:
12+
value: "credits: This issue template is heavily inspired by [pydantic template](https://github.com/pydantic/pydantic/tree/main/.github/ISSUE_TEMPLATE)"
13+
14+
15+
- type: checkboxes
16+
id: checks
17+
attributes:
18+
label: Initial Checks
19+
description: |
20+
Just a few checks to make sure you need to create a bug report.
21+
options:
22+
- label: I have read and followed [the docs](https://docs.docarray.org/) and still think this is a bug
23+
required: true
24+
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Description
29+
description: |
30+
Please explain what you're seeing and what you would expect to see.
31+
32+
Please provide as much detail as possible to make understanding and solving your problem as quick as possible. 🙏
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: example
38+
attributes:
39+
label: Example Code
40+
description: >
41+
If applicable, please add a self-contained,
42+
[minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example)
43+
demonstrating the bug.
44+
45+
placeholder: |
46+
import docarray
47+
48+
...
49+
render: Python
50+
51+
- type: textarea
52+
id: version
53+
attributes:
54+
label: Python, Pydantic & OS Version
55+
description: |
56+
Which version of Python & Pydantic are you using, and which Operating System?
57+
58+
Please run the following command and copy the output below:
59+
60+
```bash
61+
python -c "import docarray; print(docarray.__version__);"
62+
```
63+
64+
render: Text
65+
validations:
66+
required: true

‎.github/ISSUE_TEMPLATE/bug-v2.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: 🐛 DocArray Bug (>=0.30.0 )
2+
description: Report a bug or unexpected behavior in DocArray (v2) above (0.30.0)
3+
labels: [bug V2, unconfirmed]
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thank you for contributing to DocArray! 🙌
9+
10+
- type: markdown
11+
attributes:
12+
value: "credits: This issue template is heavily inspired by [pydantic template](https://github.com/pydantic/pydantic/tree/main/.github/ISSUE_TEMPLATE)"
13+
14+
15+
- type: checkboxes
16+
id: checks
17+
attributes:
18+
label: Initial Checks
19+
description: |
20+
Just a few checks to make sure you need to create a bug report.
21+
options:
22+
- label: I have read and followed [the docs](https://docs.docarray.org/) and still think this is a bug
23+
required: true
24+
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Description
29+
description: |
30+
Please explain what you're seeing and what you would expect to see.
31+
32+
Please provide as much detail as possible to make understanding and solving your problem as quick as possible. 🙏
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: example
38+
attributes:
39+
label: Example Code
40+
description: >
41+
If applicable, please add a self-contained,
42+
[minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example)
43+
demonstrating the bug.
44+
45+
placeholder: |
46+
import docarray
47+
48+
...
49+
render: Python
50+
51+
- type: textarea
52+
id: version
53+
attributes:
54+
label: Python, Pydantic & OS Version
55+
description: |
56+
Which version of Python & Pydantic are you using, and which Operating System?
57+
58+
Please run the following command and copy the output below:
59+
60+
```bash
61+
python -c "import docarray; print(docarray.__version__);"
62+
```
63+
64+
render: Text
65+
validations:
66+
required: true
67+
68+
- type: checkboxes
69+
id: affected-components
70+
attributes:
71+
label: Affected Components
72+
description: Which of the following parts of pydantic does this feature affect?
73+
# keep this lis in sync with bug.yml
74+
options:
75+
- label: '[Vector Database / Index](https://docs.docarray.org/user_guide/storing/docindex/)'
76+
- label: '[Representing](https://docs.docarray.org/user_guide/representing/first_step)'
77+
- label: '[Sending](https://docs.docarray.org/user_guide/sending/first_step/)'
78+
- label: '[storing](https://docs.docarray.org/user_guide/storing/first_step/)'
79+
- label: '[multi modal data type](https://docs.docarray.org/data_types/first_steps/)'
80+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 🤔 Ask a Question
4+
url: 'https://github.com/docarray/docarray/discussions/new?category=question'
5+
about: Ask a question about how to use pydantic using github discussions
6+
- name: 🤔 Ask a Question in discord
7+
url: 'https://discord.com/invite/WaMp6PVPgR'
8+
about: Or in our discord channel

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: 🚀 DocArray Feature request
2+
description: |
3+
Suggest a new feature for DocArray
4+
5+
labels: [feature request]
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: Thank you for contributing to docarray! ✊
11+
12+
- type: markdown
13+
attributes:
14+
value: "credits: This issue template is heavily inspired by [pydantic template](https://github.com/pydantic/pydantic/tree/main/.github/ISSUE_TEMPLATE)"
15+
16+
- type: checkboxes
17+
id: searched
18+
attributes:
19+
label: Initial Checks
20+
description: |
21+
Just a few checks to make sure you need to create a feature request.
22+
23+
options:
24+
- label: I have searched Google & GitHub for similar requests and couldn't find anything
25+
required: true
26+
- label: I have read and followed [the docs](https://docs.docarray.org) and still think this feature is missing
27+
required: true
28+
29+
- type: textarea
30+
id: description
31+
attributes:
32+
label: Description
33+
description: |
34+
Please give as much detail as possible about the feature you would like to suggest. 🙏
35+
36+
You might like to add:
37+
* A demo of how code might look when using the feature
38+
* Your use case(s) for the feature
39+
* Why the feature should be added to DocArray (as opposed to another library or just implemented in your code)
40+
validations:
41+
required: true
42+
43+
- type: checkboxes
44+
id: affected-components
45+
attributes:
46+
label: Affected Components
47+
description: Which of the following parts of DocArray does this feature affect?
48+
# keep this lis in sync with bug.yml
49+
options:
50+
- label: '[Vector Database / Index](https://docs.docarray.org/user_guide/storing/docindex/)'
51+
- label: '[Representing](https://docs.docarray.org/user_guide/representing/first_step)'
52+
- label: '[Sending](https://docs.docarray.org/user_guide/sending/first_step/)'
53+
- label: '[storing](https://docs.docarray.org/user_guide/storing/first_step/)'
54+
- label: '[multi modal data type](https://docs.docarray.org/data_types/first_steps/)'

0 commit comments

Comments
 (0)