Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.62 KB

TECHNICAL-SETUP.md

File metadata and controls

59 lines (36 loc) · 1.62 KB
Raw

Technical Setup

To ensure you have a successful experience working with Pylons, your local system must meet these technical requirements.

Install Go

This installation method removes existing Go installations, installs Go in /usr/local/go/bin/go, and sets the environment variables.

  1. Go to https://golang.org/dl.
  2. Download the binary release that is suitable for your system.
  3. Follow the installation instructions.

Note: We recommend not using brew to install Go.

Install Git pre-commit Hook

Git pre-commit hooks run before any commit to the Git repository. These hooks verify that each commit passes basic formatting and linting checks.

  • Homebrew

    brew install pre-commit

  • Pip package manager

    pip install pre-commit

Install pre-commit in Your Local Pylons Repo

After installing the pre-commit binary, run the following command in the base directory of the pylons repository:

pre-commit install

Now, any time git commit * is run, the pre-commit hooks run before the commit can be finalized.

Install Go Linters Aggregator

The golangci-lint linter runner is used in the make lint command that is provided to developers.

To install golangci-lint into $GOPATH/bin, run:

curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.41.1

Install goimports tool

The goimports tool is used int the make format command taht is provided to developers.

To install goimports using the go get command:

go get golang.org/x/tools/cmd/goimports