From 296dcc3e422c71a052888f16c582dbda2d919017 Mon Sep 17 00:00:00 2001 From: Lyonnet Date: Wed, 16 Oct 2024 21:53:45 +0800 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 20 ++++++++++++------- .github/ISSUE_TEMPLATE/feature_request.md | 5 ++--- .github/ISSUE_TEMPLATE/question.md | 24 +++++++++++++++++++++++ 3 files changed, 39 insertions(+), 10 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9d3c63a8..b8381c41 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 761c534c..4180f3e1 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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 --- diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..f5591a2f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -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