Skip to content

Commit 3196be9

Browse files
Yeray Diaz Diazjcugat
andauthored
Update contributing docs (#1011)
* Update contributing docs * Update docs/contributing.md Co-authored-by: Josep Cugat <jcugat@gmail.com> * Update docs/contributing.md Co-authored-by: Josep Cugat <jcugat@gmail.com> * Update docs/contributing.md Co-authored-by: Josep Cugat <jcugat@gmail.com> Co-authored-by: Josep Cugat <jcugat@gmail.com>
1 parent 620b067 commit 3196be9

7 files changed

Lines changed: 18 additions & 10 deletions

β€Ždocs/contributing.mdβ€Ž

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Documentation pages are located under the `docs/` folder.
8484
To run the documentation site locally (useful for previewing changes), use:
8585

8686
```shell
87-
$ scripts/docs-serve
87+
$ scripts/docs
8888
```
8989

9090
## Resolving Build / Travis Failures
@@ -93,15 +93,15 @@ Once you've submitted your pull request, the test suite will automatically run,
9393
If the test suite fails, you'll want to click through to the "Details" link, and try to identify why the test suite failed.
9494

9595
<p align="center" style="margin: 0 0 10px">
96-
<img src="https://raw.githubusercontent.com/encode/httpx/master/docs/img/travis-fail.png" alt='Failing PR commit status'>
96+
<img src="https://raw.githubusercontent.com/encode/httpx/master/docs/img/gh-actions-fail.png" alt='Failing PR commit status'>
9797
</p>
9898

9999
Here are some common ways the test suite can fail:
100100

101101
### Check Job Failed
102102

103103
<p align="center" style="margin: 0 0 10px">
104-
<img src="https://raw.githubusercontent.com/encode/httpx/master/docs/img/travis-fail-check.png" alt='Failing Travis lint job'>
104+
<img src="https://raw.githubusercontent.com/encode/httpx/master/docs/img/gh-actions-fail-check.png" alt='Failing GitHub action lint job'>
105105
</p>
106106

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

124124
<p align="center" style="margin: 0 0 10px">
125-
<img src="https://raw.githubusercontent.com/encode/httpx/master/docs/img/travis-fail-test.png" alt='Failing Travis test job'>
125+
<img src="https://raw.githubusercontent.com/encode/httpx/master/docs/img/gh-actions-fail-test.png" alt='Failing GitHub action test job'>
126126
</p>
127127

128128
This job failing means the unit tests failed or not all code paths are covered by unit tests.
@@ -131,13 +131,11 @@ If tests are failing you will see this message under the coverage report:
131131

132132
`=== 1 failed, 435 passed, 1 skipped, 1 xfailed in 11.09s ===`
133133

134-
If tests succeed but coverage isn't 100% you will see this message under the coverage report:
134+
If tests succeed but coverage doesn't reach our current threshold, you will see this
135+
message under the coverage report:
135136

136137
`FAIL Required test coverage of 100% not reached. Total coverage: 99.00%`
137138

138-
Look at the [coverage report from codecov](https://codecov.io/gh/encode/httpx/pulls)
139-
for the pull request for help debugging coverage.
140-
141139
## Releasing
142140

143141
*This section is targeted at HTTPX maintainers.*
@@ -153,9 +151,19 @@ Before releasing a new version, create a pull request that includes:
153151
- Keep it concise and to-the-point. 🎯
154152
- **A version bump**: see `__version__.py`.
155153

156-
For an example, see [#362](https://github.com/encode/httpx/pull/362).
154+
For an example, see [#1006](https://github.com/encode/httpx/pull/1006).
155+
156+
Once the release PR is merged, create a
157+
[new release](https://github.com/encode/httpx/releases/new) including:
158+
159+
- Tag version like `0.13.3`.
160+
- Release title `Version 0.13.3`
161+
- Description copied from the changelog.
162+
163+
Once created this release will be automatically uploaded to PyPI.
157164

158-
Once the release PR is merged, run `$ scripts/publish` to publish the new release to PyPI.
165+
If something goes wrong with the PyPI job the release can be published using the
166+
`scripts/publish` script.
159167

160168
## Development proxy setup
161169

242 KB
Loading
416 KB
Loading

β€Ždocs/img/gh-actions-fail.pngβ€Ž

108 KB
Loading
-7.54 KB
Binary file not shown.
-20.2 KB
Binary file not shown.

β€Ždocs/img/travis-fail.pngβ€Ž

-24.2 KB
Binary file not shown.

0 commit comments

Comments
Β (0)