CONTRIBUTING

Contributions are always welcome, no matter how large or small. Before contributing, please check to see if the issue is already being tracked and if there is already a PR.

Setup

Install Go 1.15.x

Chestnut uses the Go Modules support built into Go 1.11 to build. The easiest is to clone Chestnut in a directory outside of GOPATH, as in the following example:

$ git clone https://github.com/jrapoport/chestnut
$ cd chestnut
$ make deps

Running examples

$ make examples

Testing

$ make test

Pull Requests

Pull requests are welcome!.

Fork the repo and create your branch from master.
If you've added code that should be tested, add tests.
If you've changed APIs, update the documentation.
Ensure the test suite passes.
Make sure your code lints.

# will run fmt, lint, & vet
$ make pr

License

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

1008 B Raw Permalink Blame History