mirror of https://github.com/hashicorp/consul
1.8 KiB
1.8 KiB
Contributing
If you submit a pull request, please keep the following guidelines in mind:
- Code should be
go fmt
compliant. - Types, structs and funcs should be documented.
- Tests pass.
Getting set up
Assuming your $GOPATH
is set up according to your desires, run:
go get github.com/digitalocean/godo
go get -u github.com/stretchr/testify/assert
Running tests
When working on code in this repository, tests can be run via:
go test .
Versioning
Godo follows semver versioning semantics. New functionality should be accompanied by increment to the minor version number. The current strategy is to release often. Any code which is complete, tested, reviewed, and merged to master is worthy of release.
Releasing
Releasing a new version of godo is currently a manual process.
- Update the
CHANGELOG.md
with your changes. If a version header for the next (unreleased) version does not exist, create one. Include one bullet point for each piece of new functionality in the release, including the pull request ID, description, and author(s).
## [v1.8.0] - 2019-03-13
- #210 Expose tags on storage volume create/list/get. - @jcodybaker
- #123 Update test dependencies - @digitalocean
- Update the
libraryVersion
number ingodo.go
. - Make a pull request with these changes. This PR should be separate from the PR containing the godo changes.
- Once the pull request has been merged, visit https://github.com/digitalocean/godo/releases and click
Draft a new release
. - Update the
Tag version
andRelease title
field with the new godo version. Be sure the version has av
prefixed in both places. Exv1.8.0
. - Copy the changelog bullet points to the description field.
- Publish the release.