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
docs: fix Linux deps and improve contribution setup instructions
- Replace obsolete libjpeg8-dev with libjpeg-dev (virtual metapackage,
works on both Debian and Ubuntu); clarify that -dev headers are only
needed when building Pillow from source, not for normal development
- Rewrite contribution setup to use `hatch shell` (consistent with other
openZIM repos like ted, warc2zim, youtube); clarify that all commands
must be run from the local clone root; add note on what pre-commit install does
Closes#152, Closes#153
@@ -68,11 +73,29 @@ This project adheres to openZIM's [Contribution Guidelines](https://github.com/o
68
73
69
74
This project has implemented openZIM's [Python bootstrap, conventions and policies](https://github.com/openzim/_python-bootstrap/docs/Policy.md)**v1.0.2**.
70
75
76
+
All instructions below must be run from the root of your local clone of this repository.
77
+
78
+
If you do not already have it on your system, install [hatch](https://hatch.pypa.io/latest/install/):
79
+
71
80
```shell
72
81
pip install hatch
73
-
pip install ".[dev]"
82
+
```
83
+
84
+
Start a hatch shell — this will install all dependencies including dev in an isolated virtual environment:
85
+
86
+
```shell
87
+
hatch shell
88
+
```
89
+
90
+
Set up the pre-commit Git hook (runs linters automatically before each commit):
0 commit comments