Skip to content

Commit 635ad5e

Browse files
committed
chore: update README
Refs: KEH-282
1 parent da5af23 commit 635ad5e

1 file changed

Lines changed: 29 additions & 9 deletions

File tree

README.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -175,15 +175,6 @@ class Query(
175175
```
176176

177177

178-
## Code format
179-
180-
This project uses [`black`](https://github.com/ambv/black) for Python code formatting.
181-
We follow the basic config, without any modifications. Basic `black` commands:
182-
183-
* To let `black` do its magic: `black .`
184-
* To see which files `black` would change: `black --check .`
185-
186-
187178
## Troubleshooting guide
188179
1. Cannot receive email even though it was sent successfully
189180

@@ -206,3 +197,32 @@ We follow the basic config, without any modifications. Basic `black` commands:
206197

207198

208199
Note that it only works if you are using `django-anymail` as your email backend
200+
201+
202+
## For developers
203+
204+
### Prerequisites
205+
206+
- [Hatch](https://hatch.pypa.io/latest/install/)
207+
208+
### Testing
209+
210+
Run the tests with:
211+
212+
```
213+
hatch test
214+
```
215+
216+
Test all environments in the matrix with:
217+
218+
```
219+
hatch test -a
220+
```
221+
222+
### Available Hatch scripts
223+
224+
| Command | Description | Example |
225+
| --- | --- | --- |
226+
| `hatch run test <args>` | Run pytest directly | `hatch run test -k login` |
227+
| `hatch run lint` | Install and run pre-commit hooks | `hatch run lint` |
228+
| `hatch run manage <args>` | Run Django management commands | `hatch run manage migrate` |

0 commit comments

Comments
 (0)