Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 844 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 844 Bytes

Contributing

First, please intall the dev dependencies.

pip install -r requirements-dev.txt

Before contributing to this project, please make sure that your git config is correct:

git config --global user.name "John Doe"
git config --global user.email johndoe@example.com

Follow the installation instructions here to install pre-commit hooks. Then, use the pre-commit install command to install Black code formatter.

pip install pre-commit
pre-commit install
pre-commit run --all-files

If you change scraping logic, make sure to run the compare.py utility to visualize the number of records scraped without and with your proposed modification.

python compare.py results/events_20240125_194439.json results/events_20240130_121930.json