Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

75 lines (51 loc) · 1.82 KB
Raw

Contributing

I love pull requests from everyone!

Getting Started

Install Go

First you'll need to make sure you have go version 1.7 or later. golang.org has some good instructions on installing Go.

Getting the source

If you will be contributing, then you'll want to fork the repository.

Once you've forked it, then you can clone the source:

$ git clone git@github.com:<your-username>/<repository-name>.git

Fetch the required dependencies:

$ script/bootstrap

Before you do any changes, make sure the tests pass:

$ script/test

Make your change. Add tests for your change. Make the tests pass:

$ script/test

Push to your fork and submit a pull request.

At this point you're waiting on me. I try to be responsive to pull requests, but you know life can get in the way. I may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

Releases

  1. Update the CHANGELOG.md. See keepachangelog.com for info.

  2. Commit CHANGELOG.md

  3. Copy the current change log entry for the version to be released.

  4. Tag the new version. Example:

    $ git tag v0.1.0

  5. Push up the commit and tag:

    $ git push
...
$ git push --tags
...

  6. Go to the releases page

    1. Click on "Edit"
    2. The name should match the tag. e.g. v0.1.0
    3. Paste in the change log entry.
    4. Save.