From: Florimond Manca <florimond.manca@gmail.com>
Date: Sun, 29 Mar 2020 13:55:12 +0000 (+0200)
Subject: Add issue templates (#880)
X-Git-Tag: 0.13.0.dev0~11
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4ef5de4002233537861ce1e17685d6540ee0d9cd;p=thirdparty%2Fhttpx.git

Add issue templates (#880)

* Add issue templates

* Fix typos/phrasing

* Swap docs and GH search

Co-Authored-By: Yeray Diaz Diaz <yeraydiazdiaz@gmail.com>

* Drop code example in favor of prose

* Update .github/ISSUE_TEMPLATE/2-bug-report.md

Co-Authored-By: Yeray Diaz Diaz <yeraydiazdiaz@gmail.com>

Co-authored-by: Yeray Diaz Diaz <yeraydiazdiaz@gmail.com>
---

diff --git a/.github/ISSUE_TEMPLATE/1-question.md b/.github/ISSUE_TEMPLATE/1-question.md
new file mode 100644
index 00000000..d93521ab
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1-question.md
@@ -0,0 +1,17 @@
+---
+name: Question
+about: Ask a question
+---
+
+### Checklist
+
+<!-- To help keep this issue tracker clean and focused, please make sure you tried *all* the following resources before submitting your question. -->
+
+- [ ] I searched the [HTTPX documentation](https://www.python-httpx.org) but couldn't find what I'm looking for.
+- [ ] I looked through similar issues on GitHub, but didn't find anything.
+- [ ] I looked up "How to do ... in HTTPX" on a search engine and didn't find any information.
+- [ ] I asked the [community chat](https://gitter.im/encode/community) for help but didn't get an answer.
+
+### Question
+
+<!-- Please ask your question here. -->
diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.md b/.github/ISSUE_TEMPLATE/2-bug-report.md
new file mode 100644
index 00000000..a2060307
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-bug-report.md
@@ -0,0 +1,61 @@
+---
+name: Bug report
+about: Report a bug to help improve this project
+---
+
+### Checklist
+
+<!-- Please make sure you check all these items before submitting your bug report. -->
+
+- [ ] The bug is reproducible against the latest release and/or `master`.
+- [ ] There are no similar issues or pull requests to fix it yet.
+
+### Describe the bug
+
+<!-- A clear and concise description of what the bug is. -->
+
+### To reproduce
+
+<!-- Provide a *minimal* example with steps to reproduce the bug locally.
+
+NOTE: try to keep any external dependencies *at an absolute minimum* (servers, proxies, certificates...).
+In other words, remove anything that doesn't make the bug go away.
+
+If you need a local server to replicate against, you can build one using eg. Starlette [0] and Uvicorn [1], or any tool you feel comfortable with. Check out other issues for examples and remember to share setup instructions here. :-)
+
+[0]: https://www.starlette.io
+[1]: https://www.uvicorn.org
+-->
+
+### Expected behavior
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+### Actual behavior
+
+<!-- A clear and concise description of what actually happens. -->
+
+### Debugging material
+
+<!-- Any tracebacks, screenshots, etc. that can help understanding the problem.
+
+NOTE:
+- Please list tracebacks in full (don't truncate them).
+- If relevant, consider turning on DEBUG or TRACE logs for additional details (see https://www.python-httpx.org/environment_variables/#httpx_log_level).
+- Consider using `<details>` to make tracebacks/logs collapsible if they're very large (see https://gist.github.com/ericclemmons/b146fe5da72ca1f706b2ef72a20ac39d).
+-->
+
+### Environment
+
+- OS: <!-- eg Linux/Windows/macOS. -->
+- Python version: <!-- eg 3.8.2 (get it with `$ python -V`). -->
+- HTTPX version: <!-- eg 0.12.0 (get it with `$ pip show httpx`). -->
+- Async environment: <!-- eg asyncio/trio. If using asyncio, include whether the bug reproduces on trio (and vice versa). -->
+- HTTP proxy: <!-- yes/no, if yes please try reproducing without it. -->
+- Custom certificates: <!-- yes/no, if yes please try reproducing without them. If the bug is related to SSL/TLS, you can setup HTTPS on a local server using these instructions: https://www.python-httpx.org/advanced/#making-https-requests-to-a-local-server. -->
+
+### Additional context
+
+<!-- Any additional information that can help understanding the problem.
+
+Eg. linked issues, or a description of what you were trying to achieve. -->
diff --git a/.github/ISSUE_TEMPLATE/3-feature-request.md b/.github/ISSUE_TEMPLATE/3-feature-request.md
new file mode 100644
index 00000000..a4237e28
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3-feature-request.md
@@ -0,0 +1,34 @@
+---
+name: Feature request
+about: Suggest an idea for this project.
+---
+
+### Checklist
+
+<!-- Please make sure you check all these items before submitting your feature request. -->
+
+- [ ] There are no similar issues or pull requests for this yet.
+- [ ] I discussed this idea on the [community chat](https://gitter.im/encode/community) and feedback is positive.
+
+### Is your feature related to a problem? Please describe.
+
+<!-- A clear and concise description of what you are trying to achieve.
+
+Eg "I want to be able to [...] but I can't because [...]". -->
+
+## Describe the solution you would like.
+
+<!-- A clear and concise description of what you would want to happen.
+
+For API changes, try to provide a code snippet of what you would like the API to look like.
+-->
+
+## Describe alternatives you considered
+
+<!-- Please describe any alternative solutions or features you've considered to solve
+your problem and why they wouldn't solve it. -->
+
+## Additional context
+
+<!-- Provide any additional context, screenshots, tracebacks, etc. about the feature here. -->
+