Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1014 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1014 Bytes

plumber

Prerequisites

Building and Testing

This project uses devbase, which exposes the following build tooling: devbase/docs/makefile.md

Replacing a Remote Version of the a Package with Local Version

This is only applicable if this repository exposes a public package.

If you want to test a package exposed in this repository in a project that uses it, you can add the following replace directive to that project's go.mod file:

replace github.com/getoutreach/plumber => /path/to/local/version/plumber

Note: This repository may have postfixed it's module path with a version, go check the first line of the go.mod file in this repository to see if that is the case. If that is the case, you will need to modify the first part of the replace directive (the part before the =>) with that postfixed path.

Linting and Unit Testing

You can run the linters and unit tests with:

make test