From 17f443a7ac8792135ae23aac5e659ea9ad06e93b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=87a=C4=9F=C4=B1l=20Ulu=C5=9Fahin?= Date: Fri, 13 Nov 2026 13:01:50 +0000 Subject: [PATCH 1/3] Revise contributing guidelines for HTTPX Updated contributing guidelines to reflect focus on hip and low-level maintenance for HTTPX. --- .github/CONTRIBUTING.md | 39 ++++++++++++++------------------------- 1 file changed, 14 insertions(+), 25 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2cbd58004b..5080b3316d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,41 +1,30 @@ # Contributing -Thank you for being interested in contributing to HTTPX. -There are many ways you can contribute to the project: +## Update for 2026 -- Try HTTPX and [report bugs/issues you find](https://github.com/encode/httpx/issues/new) -- [Implement new features](https://github.com/encode/httpx/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) -- [Review Pull Requests of others](https://github.com/encode/httpx/pulls) -- Write documentation -- Participate in discussions +Thank you for your interest in contributing to HTTPX. We’re focusing our development efforts on [hip](https://github.com/encode/hip), the next version of HTTPX. Its API and architecture are being designed to address fundamental security issues. -## Reporting Bugs or Other Issues +HTTPX is entering a period of low-level maintenance, and we have limited time for triage and support. We may only be able to consider the most serious bug reports. We’re not planning further feature development for HTTPX, but contributions to hip are welcome. -Found something that HTTPX should support? -Stumbled upon some unexpected behaviour? +---- -Contributions should generally start out with [a discussion](https://github.com/encode/httpx/discussions). -Possible bugs may be raised as a "Potential Issue" discussion, feature requests may -be raised as an "Ideas" discussion. We can then determine if the discussion needs -to be escalated into an "Issue" or not, or if we'd consider a pull request. +## Reporting Bugs -Try to be more descriptive as you can and in case of a bug report, -provide as much information as possible like: +Found an issue that affects HTTPX? Please start with [a discussion](https://github.com/encode/httpx/discussions). We have limited time for triage, so we may only be able to consider the most serious bug reports. For feature requests or other contributions, please see [hip](https://github.com/encode/hip). + +When reporting a bug, include as much detail as you can: - OS platform - Python version - Installed dependencies and versions (`python -m pip freeze`) -- Code snippet -- Error traceback - -You should always try to reduce any examples to the *simplest possible case* -that demonstrates the issue. +- A code snippet +- The error traceback -Some possibly useful tips for narrowing down potential issues... +Please reduce examples to the simplest case that demonstrates the issue. It can also help to check: -- Does the issue exist on HTTP/1.1, or HTTP/2, or both? -- Does the issue exist with `Client`, `AsyncClient`, or both? -- When using `AsyncClient` does the issue exist when using `asyncio` or `trio`, or both? +- Does the issue occur with HTTP/1.1, HTTP/2, or both? +- Does it occur with `Client`, `AsyncClient`, or both? +- With `AsyncClient`, does it occur with `asyncio`, `trio`, or both? ## Development From 8aebb37bed55d6a9d4e9d0bc78c032fc8fc3a880 Mon Sep 17 00:00:00 2001 From: Kim Christie Date: Mon, 16 Nov 2026 13:29:00 +0000 Subject: [PATCH 2/3] Apply suggestion from @lovelydinosaur --- .github/CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5080b3316d..04ef830933 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,7 +2,9 @@ ## Update for 2026 -Thank you for your interest in contributing to HTTPX. We’re focusing our development efforts on [hip](https://github.com/encode/hip), the next version of HTTPX. Its API and architecture are being designed to address fundamental security issues. +Thank you for your interest in contributing to HTTPX. + +We’re focusing our development efforts on [hip](https://github.com/encode/hip), the next version of HTTPX. It is designed to address fundamental architectural & security issues. HTTPX is entering a period of low-level maintenance, and we have limited time for triage and support. We may only be able to consider the most serious bug reports. We’re not planning further feature development for HTTPX, but contributions to hip are welcome. From 4bafb4c43e00053b1c31ff2fc91b4f82370902b9 Mon Sep 17 00:00:00 2001 From: Kim Christie Date: Mon, 16 Nov 2026 13:34:06 +0000 Subject: [PATCH 3/3] Apply suggestion from @lovelydinosaur --- .github/CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 04ef830933..340af53af5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,7 +1,5 @@ # Contributing -## Update for 2026 - Thank you for your interest in contributing to HTTPX. We’re focusing our development efforts on [hip](https://github.com/encode/hip), the next version of HTTPX. It is designed to address fundamental architectural & security issues.