From b838eb4926ac1fab64158923a0f230a73c6d5505 Mon Sep 17 00:00:00 2001 From: Andres Rivero Date: Thu, 18 Jun 2026 23:05:41 -0700 Subject: [PATCH] docs: update CONTRIBUTING.md for pydantic/httpx2 migration --- .github/CONTRIBUTING.md | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0fb4596f..a2d31a39 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,20 +1,20 @@ # Contributing -Thank you for being interested in contributing to HTTPX. +Thank you for being interested in contributing to httpx2. There are many ways you can contribute to the project: -- 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) +- Try httpx2 and [report bugs/issues you find](https://github.com/pydantic/httpx2/issues/new) +- [Implement new features](https://github.com/pydantic/httpx2/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) +- [Review Pull Requests of others](https://github.com/pydantic/httpx2/pulls) - Write documentation - Participate in discussions ## Reporting Bugs or Other Issues -Found something that HTTPX should support? +Found something that httpx2 should support? Stumbled upon some unexpected behaviour? -Contributions should generally start out with [a discussion](https://github.com/encode/httpx/discussions). +Contributions should generally start out with [a discussion](https://github.com/pydantic/httpx2/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. @@ -39,20 +39,20 @@ Some possibly useful tips for narrowing down potential issues... ## Development -To start developing HTTPX create a **fork** of the -[HTTPX repository](https://github.com/encode/httpx) on GitHub. +To start developing httpx2 create a **fork** of the +[httpx2 repository](https://github.com/pydantic/httpx2) on GitHub. Then clone your fork with the following command replacing `YOUR-USERNAME` with your GitHub username: ```shell -$ git clone https://github.com/YOUR-USERNAME/httpx +$ git clone https://github.com/YOUR-USERNAME/httpx2 ``` You can now install the project and its dependencies using: ```shell -$ cd httpx +$ cd httpx2 $ scripts/install ``` @@ -101,7 +101,7 @@ Once you've submitted your pull request, the test suite will automatically run, If the test suite fails, you'll want to click through to the "Details" link, and try to identify why the test suite failed.

- Failing PR commit status + Failing PR commit status

Here are some common ways the test suite can fail: @@ -109,7 +109,7 @@ Here are some common ways the test suite can fail: ### Check Job Failed

- Failing GitHub action lint job + Failing GitHub action lint job

This job failing means there is either a code formatting issue or type-annotation issue. @@ -130,7 +130,7 @@ a variety of reasons like invalid markdown or missing configuration within `mkdo ### Python 3.X Job Failed

- Failing GitHub action test job + Failing GitHub action test job

This job failing means the unit tests failed or not all code paths are covered by unit tests. @@ -152,17 +152,15 @@ Before releasing a new version, create a pull request that includes: - **An update to the changelog**: - We follow the format from [keepachangelog](https://keepachangelog.com/en/1.0.0/). - - [Compare](https://github.com/encode/httpx/compare/) `master` with the tag of the latest release, and list all entries that are of interest to our users: + - [Compare](https://github.com/pydantic/httpx2/compare/) `main` with the tag of the latest release, and list all entries that are of interest to our users: - Things that **must** go in the changelog: added, changed, deprecated or removed features, and bug fixes. - Things that **should not** go in the changelog: changes to documentation, tests or tooling. - Try sorting entries in descending order of impact / importance. - Keep it concise and to-the-point. 🎯 -- **A version bump**: see `__version__.py`. - -For an example, see [#1006](https://github.com/encode/httpx/pull/1006). +- **A version bump**: the version is derived automatically from git tags via `uv-dynamic-versioning` — no file edit needed, just ensure the tag is applied after the release PR merges. Once the release PR is merged, create a -[new release](https://github.com/encode/httpx/releases/new) including: +[new release](https://github.com/pydantic/httpx2/releases/new) including: - Tag version like `0.13.3`. - Release title `Version 0.13.3` @@ -170,7 +168,7 @@ Once the release PR is merged, create a Once created this release will be automatically uploaded to PyPI. -If something goes wrong with the PyPI job the release can be published using the +If something goes wrong with the PyPI job the release can be re-published using the `scripts/publish` script. ## Development proxy setup