Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.38 KB
Raw

Contributing

We welcome contributors to this Golang Client, and we'll do our best to review and merge all requests. Adding missing features as per the Wavefront API or bug fixes will be welcomed. Any functional changes will require discussion.

Opening Issues

If you encounter a bug or you are making a feature request, please open an issue in this repo.

Making Pull Requests

  1. Fork the repository
  2. Create a new branch for your change
  3. Make your changes and submit a Pull Request

Before submitting a pull request, please ensure that unit tests pass. Refer to the README.md for instructions on running unit tests.

We will review your pull request and provide feedback.

Versioning

We use Semantic Versioning on this project. The version is located inside the version file, in the root of the repository, in the format vMajor.Minor.Patch. Update this version as required.

Creating a new Release

  1. Update the CHANGELOG.md
  2. Update the version file to X.Y.Z
  3. Commit changes.
  4. Make a new tag (git tag vX.Y.Z)
  5. Push changes / tag vX.Y.Z (git push --tags)
  6. Publish a GitHub release using that tag.
    1. Entitle the release with the version.
    2. Generate release notes using the "Generate release notes" button in GitHub.