Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
lexiforest committed Oct 16, 2024
1 parent 06a1614 commit 296dcc3
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 10 deletions.
20 changes: 13 additions & 7 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
about: Report a bug in curl_cffi
title: ""
labels: bug
assignees: yifeikong

---

Please check the following items before reporting a bug, otherwise it may be closed immediately.

- [ ] **This is NOT a site-related "bugs"**, e.g. some site blocks me when using curl_cffi,
UNLESS it has been verified that the reason is missing pieces in the impersonation.
- [ ] A code snippet that can reproduce this bug is provided, even if it's a one-liner.
- [ ] Version information will be pasted as below.

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
```
# Minimal reproducible code, if possible.
# target websites, and request parameters.
# Minimal reproducible code, like target websites, and request parameters, etc.
```

**Expected behavior**
A clear and concise description of what you expected to happen.

**Versions**
- OS: [e.g. linux x64]
- curl_cffi version [e.g. 0.5.7]
- OS: [e.g. linux x64, Windows 7, macOS Sequoia]
- curl_cffi version [e.g. 0.5.7, 0.7.3]
- `pip freeze` dump

**Additional context**
- Which session are you using? async or sync?
- If using async session, which loop implementation are you using?
- If you have tried, does this work with other http clients, e.g. `requests`, `httpx` or real browsers.
5 changes: 2 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[Feature]"
about: Suggest an idea or feature for this project
title: ""
labels: enhancement
assignees: yifeikong

---

Expand Down
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Ask a question
about: Asking for how to use a feature or when you are not sure if it's a bug
title: ""
labels: question

---

**The question**

- What feature do you find confusing?
- Which site does not work? And you don't have a clue.

**Documentation suggesion**

If the documentation is missing or confusing, add your suggestion here.

**Versions**

If it's related to a specific environment, paste your env info here.

- OS: [e.g. linux x64]
- curl_cffi version [e.g. 0.5.7]
- `pip freeze` dump

0 comments on commit 296dcc3

Please sign in to comment.