Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 832 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 832 Bytes

Contributing Guide

Develop

  1. Install go
  2. Install dependencies with go get -u github.com/dideler/watcher
  3. Run tests with go test
  4. Build a dev executable with cd cmd/watcher/ && go build .

Update

Since this is a fork, it can benefit from certain upstream changes.

If there's a commit or merge request that's relevant, append ".patch" to the URL and apply it to the fork as curl -sL $PATCH_URL | git am

Release

  1. Install goreleaser
  2. Create a GitHub Personal Access Token with repo scope and export GITHUB_TOKEN
  3. Update watcher's semantic version and push a new git tag
  4. Test the release from the project's root directory: goreleaser --snapshot --skip-publish --rm-dist
  5. If the dry run was succesful, publish the release: goreleaser --rm-dist