Skip to content

Latest commit

 

History

History
executable file
·
80 lines (53 loc) · 1.35 KB

dev.md

File metadata and controls

executable file
·
80 lines (53 loc) · 1.35 KB

Getting started as a developer

To get involved with this project, create a fork and follow along.

Dependencies

  • Install asdf:

    git clone https://github.com/asdf-vm/asdf.git ~/.asdf

  • Install and use asdf plugins to manage go, python, and ruby for this project:

    source .asdf

    Alternatively, you can pick and choose which plugins to install:

    # Employ asdf for this project's python:
source .asdf python

  • Install pre-commit:

    python3 -m pip install --upgrade pip
python3 -m pip install pre-commit

  • Install Mage:

    go install github.com/magefile/mage@latest

  • Install Docker

Configure environment

  1. Install dependencies:

    mage installDeps

  2. Update and run pre-commit hooks locally:

    mage runPreCommit

  3. Compile ttpforge:

    go build -o ttpforge

Uninstall pre-commit

If you want to hold off on pre-commit until your code is at a certain point, you can disable it locally:

pre-commit uninstall

Once you want to get feedback from pre-commit, reinstall it with:

pre-commit install