Skip to content

Commit 95c14e4

Browse files
committed
Docs
1 parent ad8de1b commit 95c14e4

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,20 +73,27 @@ Now you can make your changes locally.
7373
5. When you're done making changes, check that your changes pass lints and the tests, including testing other Python versions::
7474

7575
```shell
76-
$ make lint
76+
$ just lint
7777
$ just test
7878
$ just --set python python3.9 test # Test on other versions
7979
```
8080

81-
6. Commit your changes and push your branch to GitHub::
81+
6. Write any necessary documentation, including updating the changelog (HISTORY.md). The docs can be built like so:
82+
83+
```shell
84+
$ just docs
85+
$ just htmllive # Build the docs, serve then and autoreload on changes
86+
```
87+
88+
7. Commit your changes and push your branch to GitHub::
8289

8390
```shell
8491
$ git add .
8592
$ git commit -m "Your detailed description of your changes."
8693
$ git push origin name-of-your-bugfix-or-feature
8794
```
8895

89-
7. Submit a pull request through the GitHub website.
96+
8. Submit a pull request through the GitHub website.
9097

9198
## Pull Request Guidelines
9299

HISTORY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ Our backwards-compatibility policy can be found [here](https://github.com/python
3535
- The default disambiguation hook factory is now only enabled for converters with `unstructure_strat=AS_DICT` (the default).
3636
Since the strategy doesn't support tuples, it is skipped for `unstructure_strat=AS_TUPLE` converters.
3737
([#673](https://github.com/python-attrs/cattrs/pull/673))
38+
- Switch to [`uv`](https://docs.astral.sh/uv/) and [`just`](https://just.systems/man/en/) in lieu of PDM, tox and Make.
39+
See [the Contributing section](https://catt.rs/en/v25.2.0/contributing.html#get-started) for new workflow instructions.
40+
([#671](https://github.com/python-attrs/cattrs/pull/671))
3841

3942
## 25.1.1 (2025-06-04)
4043

0 commit comments

Comments
 (0)