Skip to content

dev_environment_setup.md

Latest commit

 

History

History
22 lines (14 loc) · 924 Bytes

dev_environment_setup.md

File metadata and controls

22 lines (14 loc) · 924 Bytes
Raw

Development Environment Setup

Setting up pre-commit Git hooks

This repo uses pre-commit to manage pre-commit Git hooks for maintaining several quality and stylistic standards; see .pre-commit-config.yaml for details.

MacOS: Install with brew install pre-commit.

Windows+WSL:

  • First install Python's pip package manager with sudo apt install python3-pip.
  • Then, install pre-commit with pip install pre-commit. This should install pre-commit in the ~/.local/bin directory.
  • Add this directory to your PATH. Add the following to ~/.bashrc:
export PATH="$PATH:$HOME/.local/bin"

All developers:

  • From the root of this repo, run pre-commit install to set up a Git pre-commit hook in .git/hooks/pre-commit.
  • Then, run pre-commit install-hooks to install the environments for this project's specific hooks.