Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the contributing instructions #33

Merged
merged 2 commits into from
Feb 28, 2023
Merged

Update the contributing instructions #33

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a8425b
Update the contributing instructions
MrPowers Feb 28, 2023
a753b9c
Specify that references tables are required for running the unit tests
MrPowers Feb 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To open a shell session within the poetry environment, use
poetry shell
```

## Adding reader tests
## Generating reference tables locally

Reader test cases are defined in `dat/generated_tables.py`. Currently, they are all defined in terms of PySpark code. If there is a table that doesn't fit into that paradigm, create an issue on the repository and we will consider other modes of adding tables.

Expand All @@ -33,3 +33,12 @@ make write-generated-tables
## Adding writer tests

TBD

## Running unit tests

Note: You need to generate the reference tables locally in order to run the unit tests.

You can run the unit tests with `poetry run pytest tests`.

If you've already run `poetry shell`, you can run the tests with `pytest tests`.