Skip to content

docs: align contributor Go setup and unit tests with repository configuration #7878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
friedrichg merged 1 commit into from
Oct 14, 2026
Merged

docs: align contributor Go setup and unit tests with repository configuration #7878

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions docs/contributing/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,29 @@ make
with all the tools required. The source code is mounted from where you
run `make` into the build container as a Docker volume.)

To run the unit tests suite:
To run the unit test suite with the build container's Go toolchain:
```
go test ./...
make test
```

To run the same suite with a local Go installation, use the flags from the
`Makefile` test target:
```
go test -tags "netgo slicelabels" -timeout 30m -race -count 1 ./...
```

Keep the `slicelabels` tag: Cortex uses the slice-based Prometheus label
representation, while the vendored Prometheus package defaults to a different
representation without it.

To run the integration tests suite please see "[How integration tests work](./how-integration-tests-work.md)".

### Dependency management

We use [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to manage dependencies on external packages.
This requires a working Go environment with version 1.11 or greater, git and [bzr](http://wiki.bazaar.canonical.com/Download) installed.
For local development, install Git and a Go toolchain that satisfies the `go`
directive in the repository's `go.mod`. The build container's Go version is
specified in `build-image/Dockerfile`.

To add or update a new dependency, use the `go get` command:

Expand Down