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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Not all contributions need to start with an issue, such as typo fixes in documen
8
8
9
9
We adhere to Django's Code of Conduct in all interactions and expect all contributors to do the same. Please read the [Code of Conduct](https://www.djangoproject.com/conduct/) before contributing.
10
10
11
-
###Requirements
11
+
## Requirements
12
12
13
13
-[uv](https://github.com/astral-sh/uv) - Modern Python toolchain that handles:
14
14
- Python version management and installation
@@ -42,10 +42,9 @@ for i, line in enumerate(output_list):
42
42
]]] -->
43
43
Available recipes:
44
44
bootstrap
45
-
coverage*ARGS
45
+
coverage
46
46
lint
47
47
lock *ARGS
48
-
manage *COMMAND
49
48
test*ARGS
50
49
testall *ARGS
51
50
types *ARGS
@@ -62,6 +61,7 @@ All commands below will contain the full command as well as its `just` counterpa
62
61
The following instructions will use `uv` and assume a Unix-like operating system (Linux or macOS).
63
62
64
63
Windows users will need to adjust commands accordingly, though the core workflow remains the same.
64
+
65
65
Alternatively, any Python package manager that supports installing from `pyproject.toml` ([PEP 621](https://peps.python.org/pep-0621/)) can be used. If not using `uv`, ensure you have Python installed from [python.org](https://www.python.org/).
66
66
67
67
1. Fork the repository and clone it locally.
@@ -80,23 +80,23 @@ just bootstrap
80
80
81
81
The project uses [`pytest`](https://docs.pytest.org/) fortesting and [`nox`](https://nox.thea.codes/) to run the testsin multiple environments.
82
82
83
-
To run the test suite against the default versions of Python (lower bound of supported versions) and Django (lower bound of LTS versions), run:
83
+
To run the test suite against the default versions of Python (lower bound of supported versions) and Django (lower bound of LTS versions):
84
84
85
85
```bash
86
86
uv run nox --session test
87
87
# or
88
88
just test
89
89
```
90
90
91
-
To run the test suite against the entire matrix of supported versions of Python and Django, run:
91
+
To run the test suite against the entire matrix of supported versions of Python and Django:
92
92
93
93
```bash
94
94
uv run nox --session tests
95
95
# or
96
96
just testall
97
97
```
98
98
99
-
Both can be passed additional arguments that will be provided to pytest:
99
+
Both can be passed additional arguments that will be provided to `pytest`:
0 commit comments