Skip to content

Commit

Permalink
docs: add documentation for developers
Browse files Browse the repository at this point in the history
  • Loading branch information
phm07 committed Jan 30, 2024
1 parent c5e3f00 commit 12cba30
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Developing hcloud-cli

## Generated files
This repository contains generated files, mainly for testing purposes. These files are generated by running
```sh
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
```sh
go test ./...
```

## Build
To build the binary, run
```sh
go build -o hcloud-cli ./cmd/hcloud
```

To include version information in the resulting binary and build for all targets, use GoReleaser:
```sh
goreleaser --snapshot --skip-publish --rm-dist
```

0 comments on commit 12cba30

Please sign in to comment.