Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (38 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 2.38 KB

Contributing to Terraform Provider for OSD on Google Cloud

Thank you for your interest in contributing! This document provides guidelines for contributing to the project.

Reporting Bugs

  • Use GitHub Issues to report bugs.
  • Include the Terraform and provider versions, relevant configuration (redact secrets), and error output.
  • Describe expected vs actual behavior.

Proposing Features

  • Open a GitHub Issue with the enhancement label.
  • Describe the use case and proposed API (resource/attribute changes).
  • Reference OCM API or Red Hat documentation when relevant.

Submitting Pull Requests

  1. Fork the repository and create a branch from main.
  2. Develop your changes following the project's conventions (see AGENTS.md for AI agent guidance).
  3. Test locally: 
    make fmt        # Format Go and Terraform (runs fmt_go + fmt_tf)
make unit-test
make build
make docs       # If you changed schema or templates (CI fails if docs/ is stale)
  4. Commit with clear, imperative messages (e.g., "Add private cluster support").
  5. Push your branch and open a PR against main.
  6. Ensure CI passes and address review feedback.

Development Setup

  • Requirements: Go 1.24+, Terraform 1.0+, jq
  • Build: make build
  • Install locally: make install
  • Run examples with local build: make dev.cluster.apply, make dev.cluster.plan, make dev.cluster.destroy — these install the provider, clear locks, re-init, and run. No dev_overrides in ~/.terraformrc required.
  • Run tests: make unit-test, make subsystem-test (requires OCM mock)
  • Format: make fmt

Code Style

  • Format: Run make fmt before every PR. This runs both make fmt_go (Go) and make fmt_tf (Terraform).
  • Docs: Run make docs when you change provider schema, resources, data sources, or templates in templates/. CI fails if docs/ is out of date.
  • Go: Use gofmt; run make fmt_go.
  • Terraform: Use terraform fmt; run make fmt_tf. CI checks terraform, examples, tests, and modules.
  • Follow conventions in existing code and AGENTS.md.

Code of Conduct

By participating, you agree to abide by our Code of Conduct.