2015-03-12 02:37:47 +00:00
|
|
|
# Contributing
|
|
|
|
|
|
2020-03-31 01:52:00 +00:00
|
|
|
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:
|
2015-03-12 02:37:47 +00:00
|
|
|
|
|
|
|
|
1. Code should be `go fmt` compliant.
|
2020-03-31 01:52:00 +00:00
|
|
|
1. Types, structs and funcs should be documented.
|
|
|
|
|
1. Tests pass.
|
2015-03-12 02:37:47 +00:00
|
|
|
|
|
|
|
|
## Getting set up
|
|
|
|
|
|
2020-03-31 01:52:00 +00:00
|
|
|
`godo` uses go modules. Just fork this repo, clone your fork and off you go!
|
2019-04-08 18:34:33 +00:00
|
|
|
|
2015-03-12 02:37:47 +00:00
|
|
|
## Running tests
|
|
|
|
|
|
|
|
|
|
When working on code in this repository, tests can be run via:
|
|
|
|
|
|
|
|
|
|
```sh
|
2020-03-23 17:58:31 +00:00
|
|
|
go test -mod=vendor .
|
2015-03-12 02:37:47 +00:00
|
|
|
```
|
2019-03-13 23:09:24 +00:00
|
|
|
|
|
|
|
|
## Versioning
|
|
|
|
|
|
2020-03-31 01:52:00 +00:00
|
|
|
Godo follows [semver](https://www.semver.org) versioning semantics.
|
|
|
|
|
New functionality should be accompanied by increment to the minor
|
2020-06-29 18:51:16 +00:00
|
|
|
version number. Any code merged to main is subject to release.
|
2019-03-13 23:09:24 +00:00
|
|
|
|
|
|
|
|
## Releasing
|
|
|
|
|
|
2020-10-27 15:44:55 +00:00
|
|
|
Releasing a new version of godo is currently a manual process.
|
2020-03-31 01:52:00 +00:00
|
|
|
|
|
|
|
|
Submit a separate pull request for the version change from the pull
|
|
|
|
|
request with your changes.
|
2019-03-13 23:09:24 +00:00
|
|
|
|
2020-03-31 01:52:00 +00:00
|
|
|
1. 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).
|
2020-10-27 15:44:55 +00:00
|
|
|
For example:
|
2019-03-13 23:09:24 +00:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
## [v1.8.0] - 2019-03-13
|
|
|
|
|
|
2020-10-27 15:44:55 +00:00
|
|
|
- #210 - @jcodybaker - Expose tags on storage volume create/list/get.
|
|
|
|
|
- #123 - @digitalocean - Update test dependencies
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To generate a list of changes since the previous release in the correct
|
|
|
|
|
format, you can use [github-changelog-generator](https://github.com/digitalocean/github-changelog-generator).
|
|
|
|
|
It can be installed from source by running:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
go get -u github.com/digitalocean/github-changelog-generator
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Next, list the changes by running:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
github-changelog-generator -org digitalocean -repo godo
|
2019-03-13 23:09:24 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
2. Update the `libraryVersion` number in `godo.go`.
|
|
|
|
|
3. Make a pull request with these changes. This PR should be separate from the PR containing the godo changes.
|
2020-10-27 15:44:55 +00:00
|
|
|
4. Once the pull request has been merged, [draft a new release](https://github.com/digitalocean/godo/releases/new).
|
|
|
|
|
5. Update the `Tag version` and `Release title` field with the new godo version. Be sure the version has a `v` prefixed in both places. Ex `v1.8.0`.
|
2019-03-13 23:09:24 +00:00
|
|
|
6. Copy the changelog bullet points to the description field.
|
2019-06-05 09:02:17 +00:00
|
|
|
7. Publish the release.
|
