|
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"] |
5 | 5 | 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 |
0 commit comments