Skip to content

Commit f18e916

Browse files
committed
Add notes about the Makefile to Contributing.md
1 parent 8387b6f commit f18e916

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,25 @@ Then install the required libraries:
3838
poetry install --all-extras
3939
```
4040

41+
### Optional Makefile
42+
43+
If you use `make`, we've created shortcuts for running the commands in this document.
44+
45+
| Command | Description |
46+
|---------|-------------|
47+
| make install | Installs all dependencies using Poetry|
48+
| make redis-start | Starts Redis Stack in a Docker container on ports 6379 and 8001 |
49+
| make redis-stop | Stops the Redis Stack Docker container |
50+
| make format | Runs code formatting and import sorting |
51+
| make check-types | Runs mypy type checking |
52+
| make lint | Runs formatting, import sorting, and type checking |
53+
| make test | Runs tests, excluding those that require API keys and/or remote network calls)|
54+
| make test-all | Runs all tests, including those that require API keys and/or remote network calls)|
55+
| make check | Runs all linting targets and a subset of tests |
56+
| make docs-build | Builds the documentation |
57+
| make docs-serve | Serves the documentation locally |
58+
| make clean | Removes all generated files (cache, coverage, build artifacts, etc.) |
59+
4160
### Linting and Tests
4261

4362
Check formatting, linting, and typing:

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ lint: format check-types
2121
test:
2222
SKIP_RERANKERS=true SKIP_VECTORIZERS=true poetry run test-cov
2323

24-
check: lint test
25-
26-
integration-test:
24+
test-all:
2725
poetry run test-cov
2826

27+
check: lint test
28+
2929
docs-build:
3030
poetry run build-docs
3131

0 commit comments

Comments
 (0)