CONTRIBUTING.md

Contributing

Thank you for having an interest in contributing to the rootly CLI!

• Contributing
  • Setting up your environment
  • Checking your code
    • Unit-tests
    • Linting
  • Building
  • Release

Setting up your environment

1. Clone this repository
2. Run go get all to get all the dependencies needed.

Checking your code

Unit-tests

Just run the following command:

make test

Linting

Make sure you have the following programs installed:

• golangci-lint
• hadolint
• goreleaser

Once you have all the programs listed above run the following command:

make lint

Building

Build a binary that will go in a folder called bin with the following command:

make build

You can also build the docker image with the following command:

make docker-build

Release

You can release a new version of the rootly cli (if you have contributor access) by running the following commands:

make release VERSION="v1.0.0"

Replace v1.0.0 with the version you want to release