Skip to content

Latest commit

 

History

History
64 lines (46 loc) · 1.55 KB

macos.md

File metadata and controls

64 lines (46 loc) · 1.55 KB
Raw

MacOS notes

In order to contribute please install a developer environment

  1. Install rust
  2. Install utilities
  3. Install an IDE
  4. Setup Git

install rust with brew

On the Rust website, they recommend to install rust using this command:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

As you can see, it first installs rustup which is kind of a special install script for all the various tools around rust, including rust itself. They call that a "tool chain". With rustup you can install or update or change your rust toolchain.

Rustup itself does not really change much, so you can just as well install it via homebrew instead and leave it to a regular 'brew upgrade' to upgrade rustup now and then as well.

brew install rustup

Then go the git repo root directory and type

rustup toolchain install nightly
rustup override set nightly

yamlfmt

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

brew install yamlfmt

cocogitto

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

Install it as follows:

cargo install cocogitto
cog install-hook --all

Check the Cocogitto User Guide