Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 2.27 KB
Raw

Contributing

We welcome contributors to this Terraform Provider, 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.

We make use of go-wavefront-management-api to abstract the API from the provider. New features and bug fixes will likely require updates to go-wavefront client.

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 vX.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)
    1. A GitHub Action should generate the necessary binaries and a Release on GitHub.
      1. Binaries need to be complete before a TF Registry Resync will work.
  6. Update the GitHub Release text to match past releases. (aka version as title and summary as body)
  7. Ask the HashiCorp team to Resync the provider by sending an email to support@hashicorp.com, or by using https://support.hashicorp.com/hc/en-us

Helpful Resources for Provider Development

  • This is a good blog post by Hashicorp to get started.
  • Looking at how existing Providers work can be useful.
  • This is a good blog post to get some details on how to debug custom terraform provider.