Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
16 lines (12 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

16 lines (12 loc) · 1.16 KB

Contributing

We welcome contributions. Here’s how to get changes merged.

Submitting changes

  1. Fork the repo and create a branch from main.
  2. Make your changes. Follow the existing code style and patterns.
  3. Run tests for the code you touch:
    • Unit tests: go test ./...
    • OSS acceptance tests (needs Grafana): see README – Running Tests, e.g. make testacc-oss-docker.
  4. Run the linter before opening a PR: make golangci-lint (runs golangci-lint run ./... -v in Docker with the same version CI uses). If you have golangci-lint v2 installed locally, you can run golangci-lint run ./... -v from the repo root instead.
  5. Update generated docs if you changed resource/datasource schema or examples: run go generate ./... (or make docs). CI will fail if docs/ is out of sync.
  6. Open a pull request against main with a clear description of the change.

For questions or discussion, use the Grafana #terraform Slack channel. The Grafana Slack is public—anyone can join at slack.grafana.com.