dnote/cli/CONBTRIBUTING.md
2019-05-10 09:31:31 +10:00

818 B

Contributing

This is a guide for contributors.

Set up

First, download the project

go get github.com/dnote/dnote/cli

Go to the project root and download dependencies using dep.

dep ensure

Test

Run

./scripts/test.sh

Debug

Run Dnote with DNOTE_DEBUG=1 to print debugging statements.

Release

  • Build for all target platforms, tag, push tags
  • Release on GitHub and Dnote Homebrew tap.
VERSION=0.4.8 make release
  • Build, without releasing, for all target platforms
VERSION=0.4.8 make

Note

  • If a release is not stable,
    • disable the homebrew release by commenting out homebrew block in .goreleaser.yml
    • mark release as pre-release on GitHub release