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.
-
+
-
+
-
+