Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (36 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

41 lines (36 loc) · 1.5 KB

Development

Requirements

Build

  • Create a new sandbox (aka venv) and install required python libraries into it 
    virtualenv --python=python3.7 venv
source venv/bin/activate

# Install Python packages
pip install -r requirements.txt
pip install -r requirements-dev.txt
  • Install NPM packages. 
    npm install
  • Run make to execute all tests.

IDE Setup

  • Setup the Python Interpreter
    • For PyCharm, go to Settings -> Project Settings -> Project Interpreter.
    • For IntelliJ, go to File -> Project Structure -> Project -> Project SDK.
    • Add a Virtualenv Environment from an Existing environment and set the Interpreter to YOUR_REPO_ROOT/venv/bin/python.

Pull Request

  • We force the following checks in before changes can be merged into master: eslint, prettier, isort, black, pylint, mypy.
    • You can run make to executes all checks.
    • To fix any formatting or import errors, you can simply run make format.
    • For more details, see the format and format-check tasks in the Makefile