Skip to content

Commit

Permalink
Add notes about the Makefile to Contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abrookins committed Jan 24, 2025
1 parent 8387b6f commit f18e916
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,25 @@ Then install the required libraries:
poetry install --all-extras
```

### Optional Makefile

If you use `make`, we've created shortcuts for running the commands in this document.

| Command | Description |
|---------|-------------|
| make install | Installs all dependencies using Poetry|
| make redis-start | Starts Redis Stack in a Docker container on ports 6379 and 8001 |
| make redis-stop | Stops the Redis Stack Docker container |
| make format | Runs code formatting and import sorting |
| make check-types | Runs mypy type checking |
| make lint | Runs formatting, import sorting, and type checking |
| make test | Runs tests, excluding those that require API keys and/or remote network calls)|
| make test-all | Runs all tests, including those that require API keys and/or remote network calls)|
| make check | Runs all linting targets and a subset of tests |
| make docs-build | Builds the documentation |
| make docs-serve | Serves the documentation locally |
| make clean | Removes all generated files (cache, coverage, build artifacts, etc.) |

### Linting and Tests

Check formatting, linting, and typing:
Expand Down
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ lint: format check-types
test:
SKIP_RERANKERS=true SKIP_VECTORIZERS=true poetry run test-cov

check: lint test

integration-test:
test-all:
poetry run test-cov

check: lint test

docs-build:
poetry run build-docs

Expand Down

0 comments on commit f18e916

Please sign in to comment.