MacOS Notes

In order to contribute please install a developer environment

  1. Install Homebrew—i.e. the brew command, used to install other tools
  2. Install rust—the primary programming language used to create GraphArch
  3. Install utilities
    • cocogitto—a tool, the cog command, for “conventional commits”
    • yamlfmt—to format .yml or .yaml files
  4. Install an IDE
  5. Setup Git

Install HomeBrew

Paste the following into your terminal:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

The brew command is used to install most other tools.

Install yamlfmt

Install yamlfmt — to format .yml or .yaml files — by using brew:

brew install yamlfmt

Install cocogitto

We recommend using cocogitto for anything to do with “conventional commits”.

Install it as follows, assuming you have cargo installed (if not, see Install Rust):

cargo install cocogitto
cog install-hook --all

Check the Cocogitto User Guide