Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 732 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 732 Bytes

Contributing

yutu is a cli tool built using the cobra. Feel free to contribute to the project under these conventions:

  • Commit messages should follow the gitmoji convention.
  • Follow the existing naming and project structure.

Here are some commands which may useful.

# upgrade all dependencies
❯ go get -u ./...

# run tests
## unit tests
❯ go test ./...
## verify binary commands, detect shorthands conflicts, etc.
❯ ./scripts/command-test.sh

# build the binary
## install goreleaser: https://goreleaser.com/install
❯ GITHUB_REPOSITORY=eat-pray-ai/yutu goreleaser build --clean --auto-snapshot

# script to install yutu
❯ ./scripts/install.sh