Skip to content

Commit 847790c

Browse files
committed
chore: add issue template
1 parent 725e539 commit 847790c

3 files changed

Lines changed: 176 additions & 70 deletions

File tree

Lines changed: 106 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,107 @@
1-
name: 🐛 Bug Report
2-
description: Create a report to help us reproduce and fix the bug
3-
labels: 'bug'
4-
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior in the Replane Python SDK
3+
title: "[Bug]: "
4+
labels: ["bug"]
55
body:
6-
- type: markdown
7-
attributes:
8-
value: >
9-
#### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/replane-dev/replane-python/issues?q=is%3Aissue+sort%3Acreated-desc+).
10-
- type: textarea
11-
attributes:
12-
label: 🐛 Describe the bug
13-
description: |
14-
Please provide a clear and concise description of what the bug is.
15-
16-
If relevant, add a minimal example so that we can reproduce the error by running the code. It is very important for the snippet to be as succinct (minimal) as possible, so please take time to trim down any irrelevant code to help us debug efficiently. We are going to copy-paste your code and we expect to get the same result as you did: avoid any external data, and include the relevant imports, etc. For example:
17-
18-
```python
19-
# All necessary imports at the beginning
20-
import replane
21-
22-
# A succinct reproducing example trimmed down to the essential parts:
23-
assert False is True, "Oh no!"
24-
```
25-
26-
If the code is too long (hopefully, it isn't), feel free to put it in a public gist and link it in the issue: https://gist.github.com.
27-
28-
Please also paste or describe the results you observe instead of the expected results. If you observe an error, please paste the error message including the **full** traceback of the exception. It may be relevant to wrap error messages in ```` ```triple quotes blocks``` ````.
29-
placeholder: |
30-
A clear and concise description of what the bug is.
31-
validations:
32-
required: true
33-
- type: textarea
34-
attributes:
35-
label: Versions
36-
description: |
37-
Please run the following and paste the output below.
38-
```sh
39-
python --version && pip freeze
40-
```
41-
validations:
42-
required: true
43-
- type: markdown
44-
attributes:
45-
value: >
46-
Thanks for contributing 🎉!
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the form below to help us understand and fix the issue.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of the bug.
16+
placeholder: What happened?
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: steps
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior.
25+
placeholder: |
26+
1. Initialize client with '...'
27+
2. Call method '...'
28+
3. See error
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What did you expect to happen?
37+
placeholder: What should have happened?
38+
validations:
39+
required: true
40+
41+
- type: input
42+
id: sdk-version
43+
attributes:
44+
label: SDK Version
45+
description: What version of the Python SDK are you using?
46+
placeholder: "e.g., 0.1.0"
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: python-version
52+
attributes:
53+
label: Python Version
54+
description: What version of Python are you using?
55+
placeholder: "e.g., 3.11.0"
56+
validations:
57+
required: true
58+
59+
- type: dropdown
60+
id: client-type
61+
attributes:
62+
label: Client Type
63+
description: Which client are you using?
64+
options:
65+
- Sync (Replane)
66+
- Async (AsyncReplane)
67+
- Both
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: environment
73+
attributes:
74+
label: Environment
75+
description: Any relevant environment details (OS, framework, etc.)
76+
placeholder: |
77+
- OS: Ubuntu 22.04
78+
- Framework: FastAPI / Django / Flask
79+
- Extra dependencies: httpx version, etc.
80+
validations:
81+
required: false
82+
83+
- type: textarea
84+
id: code
85+
attributes:
86+
label: Code Sample
87+
description: Minimal code to reproduce the issue.
88+
render: python
89+
validations:
90+
required: false
91+
92+
- type: textarea
93+
id: logs
94+
attributes:
95+
label: Error Output / Logs
96+
description: Please copy and paste any relevant error messages or logs.
97+
render: shell
98+
validations:
99+
required: false
100+
101+
- type: textarea
102+
id: context
103+
attributes:
104+
label: Additional Context
105+
description: Add any other context about the problem here.
106+
validations:
107+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Community Discussions
4+
url: https://github.com/orgs/replane-dev/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: Documentation
7+
url: https://replane.dev/docs/sdk/python
8+
about: Check the Python SDK documentation
9+
Lines changed: 61 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,62 @@
1-
name: 🚀 Feature request
2-
description: Submit a proposal/request for a new feature
3-
labels: 'feature request'
4-
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for the Replane Python SDK
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
55
body:
6-
- type: textarea
7-
attributes:
8-
label: 🚀 The feature, motivation and pitch
9-
description: >
10-
A clear and concise description of the feature proposal. Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., *"I'm working on X and would like Y to be possible"*. If this is related to another GitHub issue, please link here too.
11-
validations:
12-
required: true
13-
- type: textarea
14-
attributes:
15-
label: Alternatives
16-
description: >
17-
A description of any alternative solutions or features you've considered, if any.
18-
- type: textarea
19-
attributes:
20-
label: Additional context
21-
description: >
22-
Add any other context or screenshots about the feature request.
23-
- type: markdown
24-
attributes:
25-
value: >
26-
Thanks for contributing 🎉!
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature! Please fill out the form below to help us understand your idea.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like.
25+
placeholder: A clear and concise description of what you want to happen.
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Describe any alternative solutions or features you've considered.
34+
placeholder: Other approaches you've thought about.
35+
validations:
36+
required: false
37+
38+
- type: dropdown
39+
id: area
40+
attributes:
41+
label: Feature Area
42+
description: Which area of the SDK does this feature relate to?
43+
options:
44+
- Sync Client
45+
- Async Client
46+
- SSE / Real-time Updates
47+
- Override Evaluation
48+
- Testing Utilities
49+
- Type Hints
50+
- Error Handling
51+
- Documentation
52+
- Other
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: context
58+
attributes:
59+
label: Additional Context
60+
description: Add any other context or code examples about the feature request here.
61+
validations:
62+
required: false

0 commit comments

Comments
 (0)