AzureRM Provider Contributor Guides#
First, thank you for your interest in contributing to the Azure Provider! And if you're unsure or anything, please do reach out for help. You can open a draft pull request (PR) or an issue with what you know or join the Slack Workspace for Contributors (Request Invite) and we'll do our best to guide you in the right direction.
Note: this documentation is a work-in-progress - if you see something that's not quite right or missing, we'd really appreciate a PR!
This contribution guide assumes you have at least a basic understanding of both Go and Terraform itself (for example you know what a Data Source and a Resource are) - more information on those can be found in the Terraform documentation.
Topics#
Getting Started#
- Overview of the Provider
- Building the Provider
- Debugging the Provider
- Running the Tests
- Opening a Pull Request
Creating New Resources & Data Sources#
- Adding a new Service Package
- Adding a new Resource
- Adding a new List Resource
- Adding a new Data Source
- When to create a new Resource vs Inline Block
Extending Existing Resources#
- Adding a new Feature
- Adding fields to an existing Resource
- Adding fields to an existing Data Source
- Adding Resource Identity
- Adding Write-Only Attributes
Maintenance & Updates#
Reference#
- Acceptance Testing
- Best Practices
- Glossary
- Naming
- Resource IDs
- Schema Design
- Provider Documentation Standards
- Working with Errors