dnote/CONBTRIBUTING.md

Contributing

This is a guide for contributors.

Set up

First, download the project

go get github.com/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

This project uses goreleaser to automate the release process.

The following will tag, push the tag, create release on GitHub, build artifacts, upload them, and push a commit to Dnote Homebrew tap.

VERSION=v0.4.2 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