You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Introduce Justfile, use uv in CI
* Pin actions
* Set `COVERAGE_PROCESS_START`
* Always cover with sysmon
* Use FAST=1 with Pypy
* Tweaks
* Also run lints
* Remove pdm, tox, migrate to uv
* Tweak .readthedocs.yml
* Tweak
* Tweak
* Use full path for just
* Try making BUILDDIR configurable
* Actually pass the argument
* Tweak some more
* Try pipx?
* Just via asdf
* Fix
* Build docs on 3.13
* Docs
3. Install your local copy into a virtualenv. Assuming you have [PDM](https://pdm.fming.dev/latest/) installed, this is how you set up your fork for local development::
58
+
3. Install your local copy into a virtualenv. Assuming you have [uv](https://docs.astral.sh/uv/) installed, this is how you set up your fork for local development::
59
59
60
60
```shell
61
61
$ cd cattrs/
62
-
$ pdm install -d -G :all
62
+
$ uv sync --all-groups --all-extras
63
63
```
64
64
65
65
4. Create a branch for local development::
66
66
67
67
```shell
68
-
$ git checkout -b name-of-your-bugfix-or-feature
68
+
$ git switch -c name-of-your-bugfix-or-feature
69
69
```
70
70
71
71
Now you can make your changes locally.
72
72
73
-
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
73
+
5. When you're done making changes, check that your changes pass lints and the tests, including testing other Python versions::
74
74
75
75
```shell
76
-
$ make lint
77
-
$ maketest
78
-
$ tox
76
+
$ just lint
77
+
$ justtest
78
+
$ just --set python python3.9 test# Test on other versions
79
79
```
80
80
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::
82
89
83
90
```shell
84
91
$ git add .
85
92
$ git commit -m "Your detailed description of your changes."
86
93
$ git push origin name-of-your-bugfix-or-feature
87
94
```
88
95
89
-
7. Submit a pull request through the GitHub website.
96
+
8. Submit a pull request through the GitHub website.
90
97
91
98
## Pull Request Guidelines
92
99
@@ -106,5 +113,5 @@ Before you submit a pull request, check that it meets these guidelines:
0 commit comments