Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

85 lines (59 loc) · 2.23 KB

Contributing to the AuthZed Cloud API Terraform Provider

Thank you for considering contributing to the AuthZed Cloud API Terraform Provider! This document provides guidelines and instructions for contributing.

Code of Conduct

Please read and follow our Code of Conduct.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/YOUR-USERNAME/terraform-provider-cloudapi.git
  3. Create a branch for your work: 
    git checkout -b your-feature-branch

Development Environment

Requirements

  • Go 1.23 or higher
  • Terraform 1.0 or higher
  • Access to an AuthZed Cloud account for testing

Building and Testing

  1. Build the provider:

    go build

  2. Run tests:

    go test ./...

  3. Install locally for testing:

    mkdir -p ~/.terraform.d/plugins/registry.terraform.io/authzed/cloudapi/0.1.0/$(go env GOOS)_$(go env GOARCH)
cp terraform-provider-cloudapi ~/.terraform.d/plugins/registry.terraform.io/authzed/cloudapi/0.1.0/$(go env GOOS)_$(go env GOARCH)/

Making Changes

Code Style

  • Follow standard Go code style and conventions
  • Use go fmt to format your code
  • Ensure your code passes go vet and golint

Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Pull Requests

  1. Update the README.md with details of changes if appropriate
  2. Update the CHANGELOG.md with details of changes
  3. The PR should work against the main branch
  4. Include appropriate tests

Documentation

  • Update documentation to reflect any changes in functionality
  • Provide examples for new features
  • Keep the README and other documentation up to date

Releasing

(For maintainers only)

  1. Update CHANGELOG.md
  2. Create a new GitHub release with a semantic version tag
  3. The release will automatically be published to the Terraform Registry

License

By contributing, you agree that your contributions will be licensed under the project's Apache 2.0 License.