mirror of
https://github.com/prometheus/prometheus.git
synced 2024-11-16 02:24:06 -08:00
c61141ce51
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
1.8 KiB
1.8 KiB
Contributing
We love contributions! You are welcome to open a pull request, but it's a good idea to open an issue and discuss your idea with us first.
Once you are ready to open a PR, 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
godo
uses go modules. Just fork this repo, clone your fork and off you go!
Running tests
When working on code in this repository, tests can be run via:
go test -mod=vendor .
Versioning
Godo follows semver versioning semantics. New functionality should be accompanied by increment to the minor version number. Any code merged to master is subject to release.
Releasing
Releasing a new version of godo is currently a manual process.
Submit a separate pull request for the version change from the pull request with your changes.
- 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, 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.