Skip to content

Commit 7392870

Browse files
added issue template/PR template
1 parent ad00a69 commit 7392870

File tree

3 files changed

+118
-0
lines changed

3 files changed

+118
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
2+
name: Bug Report
3+
description: Report a bug in the project
4+
title: "[Bug] "
5+
labels: bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## 🐛 Bug Report
11+
Please fill out all required fields to help us diagnose and fix the issue.
12+
13+
- type: input
14+
id: environment
15+
attributes:
16+
label: "Elysia version"
17+
description: "Tell us your Elysia version. (You can find this out via `pip show elysia-ai` in your environment that you installed Elysia in.)"
18+
validations:
19+
required: true
20+
21+
- type: input
22+
id: installation_method
23+
attributes:
24+
label: "Installation method"
25+
description: "How did you install Elysia? (e.g. pip, uv, conda, from source, etc.)"
26+
placeholder: "pip install elysia-ai"
27+
28+
validations:
29+
required: true
30+
31+
- type: dropdown
32+
id: app_or_python
33+
attributes:
34+
label: "Is the issue occurring in the Elysia package or the Elysia web app?"
35+
description: "Please note that if your bug looks like a frontend problem (e.g. items not displaying, etc.), you might want to submit a bug report to the Elysia frontend repository instead: https://github.com/weaviate/elysia-frontend. However, if you are getting _errors_ in the app, then it is likely the backend and suited for here."
36+
options:
37+
- "Python package (running Elysia in python)"
38+
- "Elysia web app (using the app via `elysia start`)"
39+
- "Both"
40+
41+
- type: textarea
42+
id: description
43+
attributes:
44+
label: "What happened?"
45+
description: "Clearly describe the unexpected behavior. Attach a full error log if possible. In the web app, you may have an error in the terminal you ran `elysia start` from."
46+
placeholder: "Whenever I try to run a query, I get an error message..."
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: steps-to-reproduce
52+
attributes:
53+
label: "Steps to reproduce"
54+
description: "Please provide a code snippet if applicable, or what you were doing when the issue occurred. If it seems a problem with your data, attach a (dummy) sample of your data or your schema. In Weaviate, you can do `print(client.collections.get("<your_collection_name>").config.get())`"
55+
56+
57+
- type: textarea
58+
id: additional_context
59+
attributes:
60+
label: "Additional context"
61+
description: "Tell us any additional context that might be helpful. E.g., are you running local weaviate, is it a local model (which one), any special considerations, etc."
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement
3+
title: "[Feature] "
4+
labels: enhancement
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Feature Request
10+
Please fill out all required fields to help us understand and implement the feature.
11+
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: "What feature would you like to see?"
16+
description: "Describe the feature clearly."
17+
validations:
18+
required: true
19+
20+
- type: checkboxes
21+
id: contribute
22+
attributes:
23+
label: "Would you like to contribute?"
24+
options:
25+
- label: Yes, I'd like to help implement this.
26+
- label: No, I just want to request it.
27+
28+
29+
- type: textarea
30+
id: additional-info
31+
attributes:
32+
label: "Additional Context"
33+
description: "Any links, references, or extra details?"
34+
placeholder: "Example: This feature exists in XYZ tool."
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- Before submitting any PR, please check the contributing guidelines: -->
2+
<!-- https://github.com/weaviate/elysia/blob/main/CONTRIBUTING.md -->
3+
4+
## 📝 Changes Description
5+
6+
This PR contains the following changes:
7+
8+
<!-- Add your changes here -->
9+
10+
<!-- ### Related Issue (Optional) -->
11+
12+
<!-- This PR addresses Issue #XX -->
13+
14+
## ✅ Contributor Checklist
15+
16+
<!-- -->
17+
- [] `no_reqs` tests are passing locally
18+
- [] `requires_env` tests are passing locally (optional - see [Testing guidelines](https://github.com/weaviate/elysia?tab=contributing-ov-file#testing))
19+
- [] You agree to Weaviate's [Contributor License Agreement](https://weaviate.io/service/contributor-license-agreement)
20+
21+
<!-- ## Additional Info (Optional) -->
22+
23+
<!-- Enter your info here -->

0 commit comments

Comments
 (0)