Skip to content

Commit c0e9a33

Browse files
committed
Better instructions
1 parent c7085ed commit c0e9a33

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,13 @@ poetry install --with dev
2828
# 6. Install the package in editable mode
2929
poetry run dev install-dev
3030

31-
# 7. Run tests to verify everything works
31+
# 7. Start TerminusDB server (for integration tests)
32+
docker run --pull always -d -p 127.0.0.1:6363:6363 -v terminusdb_storage:/app/terminusdb/storage --name terminusdb terminusdb/terminusdb-server:v12
33+
34+
# 8. Run tests to verify everything works
3235
poetry run dev test
3336

34-
# 8. Get help with available commands
37+
# 9. Get help with available commands
3538
poetry run dev --help
3639
```
3740

@@ -64,6 +67,17 @@ Make sure you have Python>=3.9 installed. We use [Poetry](https://python-poetry.
6467
poetry run dev install-dev
6568
```
6669

70+
5. Start TerminusDB server (required for integration tests):
71+
```bash
72+
docker run --pull always -d -p 127.0.0.1:6363:6363 -v terminusdb_storage:/app/terminusdb/storage --name terminusdb terminusdb/terminusdb-server:v12
73+
```
74+
75+
To stop the server when done:
76+
```bash
77+
docker stop terminusdb
78+
docker rm terminusdb
79+
```
80+
6781
**To run integration tests, Docker must be installed locally.**
6882

6983
We use [shed](https://pypi.org/project/shed/) to lint our code. You can run it manually with `poetry run dev lint`, or set up a pre-commit hook (requires Python 3.10+):

0 commit comments

Comments
 (0)