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
+13-22Lines changed: 13 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,35 +6,26 @@ Thanks for your interest in improving the PostHog Python SDK.
6
6
7
7
This repo requires all commits to be signed. To configure commit signing, see the [PostHog handbook](https://posthog.com/handbook/engineering/security#commit-signing).
8
8
9
-
## Testing locally
9
+
## Setup
10
10
11
11
We recommend using [uv](https://docs.astral.sh/uv/).
12
12
13
-
1. Create a virtual environment:
14
-
-`uv venv env`
15
-
- or `python3 -m venv env`
16
-
2. Activate it:
17
-
-`source env/bin/activate`
18
-
3. Install the package in editable mode with development and test dependencies:
19
-
-`uv sync --extra dev --extra test`
20
-
- or `pip install -e ".[dev,test]"`
21
-
4. Install pre-commit hooks:
22
-
-`pre-commit install`
23
-
5. Run the test suite:
24
-
-`make test`
25
-
6. Run a specific test if needed:
26
-
-`pytest -k test_no_api_key`
27
-
28
-
## Recommended `uv` workflow
29
-
30
13
```bash
31
-
uv python install 3.12
32
-
uv python pin 3.12
33
14
uv venv
34
15
source .venv/bin/activate
35
16
uv sync --extra dev --extra test
36
-
pre-commit install
37
-
make test
17
+
```
18
+
19
+
## CI-aligned checks
20
+
21
+
Run the same core checks CI uses before opening a PR:
0 commit comments