diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..652c7cf1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +# Developing hcloud-cli + +## Generated files +This repository contains generated files, mainly for testing purposes. These files are generated by running +`go generate ./...` in the root directory of this repository. Make sure to keep generated files up-to-date +when making changes to the code. + + +## Unit tests +Unit tests are located in the `internal` directory. Run them with `go test ./...`. + +## Build +To build the binary, run `go build -o hcloud-cli ./cmd/hcloud`. + +To include version information in the resulting binary and build for all targets, use GoReleaser: +`goreleaser --snapshot --skip-publish --rm-dist`.