Skip to content

Latest commit

 

History

History
28 lines (25 loc) · 1.76 KB

README.md

File metadata and controls

28 lines (25 loc) · 1.76 KB

Test Status Pre-commit Status

Python version License Codestyle Black

Setup

  • make sure you are using python > 3.8+
  • setup virtualenv using virtualenv env and activate it
  • run pip install -e "." to install dependencies. keep setup.py updated
    • rerun pip install -e "." if you make changes to models/source code. not needed for testcase changes
  • run pytest --mypy --black --isort --cov=rush --cov-report=xml --cov-report=term to run your tests
    • if black formatting tests fail, just run black . from your top level directory. Alternatively you can setup black in vscode (I highly recommend setting up all three "format on paste/save/type")
    • if isort formatting tests fail, just run isort -rc . from your top level directory.
  • all source code is under src/rush/ . That is where you should make your code