Skip to content

Commit ff75a3e

Browse files
committed
chore: update issue template
1 parent 3b43f08 commit ff75a3e

File tree

2 files changed

+102
-43
lines changed

2 files changed

+102
-43
lines changed

.github/ISSUE_TEMPLATE/report.yml

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: Issue Report (Bug report or feature request)
2+
description: Report a bug or request a feature for the Googletrans library.
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thank you for contributing to the Googletrans project!
8+
Please read the following carefully before submitting.
9+
10+
**Note:** The following types of issues will be automatically closed:
11+
- Issues related to non-async function calls
12+
- Rate-limiting issues (this is a Google limitation)
13+
- Proxy configuration issues
14+
- Issues about exceeding the 15k character limit
15+
- Issues from versions prior to 4.0.1
16+
17+
- type: checkboxes
18+
id: pre-submission-checklist
19+
attributes:
20+
label: "Before submitting, please confirm that:"
21+
options:
22+
- label: "I am using async/await syntax (non-sync calls are not supported since 4.0.0)"
23+
required: true
24+
- label: "This is not a rate-limiting issue or about exceeding the 15k character limit (Google's rate limits are not a library bug)"
25+
required: true
26+
- label: "I have checked the [README](https://github.com/ssut/py-googletrans#readme) for basic usage, known limitations, and have searched existing issues"
27+
required: true
28+
validations:
29+
required: true
30+
31+
- type: dropdown
32+
id: googletrans-version
33+
attributes:
34+
label: "Googletrans version"
35+
description: "What version of Googletrans are you using?"
36+
options:
37+
- 4.0.1+
38+
default: 0
39+
validations:
40+
required: true
41+
42+
- type: checkboxes
43+
id: issue-type
44+
attributes:
45+
label: "Issue Type"
46+
description: "What type of issue are you submitting?"
47+
options:
48+
- label: "Bug Report"
49+
- label: "Feature Request"
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: current-behavior
55+
attributes:
56+
label: "Current Behavior"
57+
description: "Describe how the bug manifests or the current behavior you are trying to improve."
58+
placeholder: "Please provide a detailed description of the issue."
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: expected-behavior
64+
attributes:
65+
label: "Expected Behavior"
66+
description: "Describe what the behavior would be without the bug or what you would like the feature to do."
67+
placeholder: "Please provide a detailed description of the expected outcome."
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: steps-to-reproduce
73+
attributes:
74+
label: "Steps to Reproduce"
75+
description: "Please explain the steps required to duplicate the issue."
76+
placeholder: |
77+
1. ...
78+
2. ...
79+
3. ...
80+
validations:
81+
required: true
82+
83+
- type: textarea
84+
id: related-code
85+
attributes:
86+
label: "Related Code"
87+
description: "Please provide a code snippet demonstrating the issue (using async/await syntax)"
88+
placeholder: |
89+
```python
90+
# Insert code snippets here
91+
```
92+
validations:
93+
required: false
94+
95+
- type: textarea
96+
id: other-information
97+
attributes:
98+
label: "Other Information"
99+
description: "List any other relevant information, such as stack traces or error messages, here."
100+
placeholder: "Any additional information that might be helpful."
101+
validations:
102+
required: false

ISSUE_TEMPLATE.md

-43
This file was deleted.

0 commit comments

Comments
 (0)