Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

52 lines (39 loc) · 1.67 KB
Raw

Contributing to the CLI Interface

Contributions are always welcome, no matter how large or small. Substantial feature requests should be proposed as an RFC. Before contributing, please read the code of conduct.

Setup

Prerequisites

  • Latest Go version (al teast 1.8+)
  • Properly set up $GOPATH and GOPATH/bin added to $PATH
  • Go's Dep tool installed:
    • Install via: curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh

Dev Workspace Setup

> cd $GOPATH/src
> mkdir -p github.com/inadarei/ && cd github.com/inadarei/
> git clone https://github.com/inadarei/justgo.git
> cd justgo/
> .githooks/install.sh
> dep ensure
> go run justgo.go <someFolderToTestInstallTo>

Warning for VS Code Users

If you are using VS Code with Go tooling, you will want to change the default "go.formatTool": "goreturns", formatter to "go.formatTool": "gofmt", instead since the former seems unable to properly detect the usage of uuid in the code and keeps removing the uuid package's import statement from code, making it error-out during a build. Gofmt has no such issues.

Pull Requests

We actively welcome your pull requests.

  1. Create an Issue or RFC for your contribution.
  2. Fork the repo and create your branch from master.
  3. If you've added code that should be tested, add tests.
  4. Update the documentation.
  5. Ensure the test suite passes.
  6. Run gofmt and goimports.

License

By contributing to Justgo, you agree that your contributions will be licensed under its MIT license.