Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

22 lines (15 loc) · 1.05 KB
Raw

How to contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

  1. Code should be go fmt formatted.
  2. Exported types, constants, variables and functions should be documented.
  3. Changes must be covered with tests.
  4. All tests must pass constantly go test ..

Versioning

NewReleases Go client follows semantic versioning. New functionality should be accompanied by increment to the minor version number.

Releasing

Any code which is complete, tested, reviewed, and merged to master can be released.

  1. Update the version number in newreleases.go.
  2. Make a pull request with these changes.
  3. Once the pull request has been merged, visit https://github.com/newreleasesio/client-go/releases and click Draft a new release.
  4. Update the Tag version and Release title field with the new NewReleases Go client version. Be sure the version has a v prefixed in both places, e.g. v1.25.0.
  5. Publish the release.