| name | contributor-guide |
| description | Provide step-by-step guidance for contributors based on their contribution type. References CONTRIBUTING.md and project conventions. Triggers on: new contributor questions, 'how do I contribute', contribution guidance requests. |
Contributor Guide
Procedure
1. Identify contribution type
Ask the contributor (or infer from context) what they want to do:
| Type | Description |
|---|
| new-resource | Add a new Azure resource type to the provider |
| update-resource | Update an existing resource's naming constraints |
| bug-fix | Fix a bug in the provider logic |
| docs | Improve documentation |
| test | Add or improve tests |
2. Provide guidance
For new-resource contributions:
- Check if the resource already exists:
grep '"name": "azurerm_<name>"' resourceDefinition.json
- Research naming constraints (see
azure-naming-research skill)
- Create an issue describing the resource (or reference existing issue)
- Edit
resourceDefinition.json — add the entry in alphabetical order
- Run
go generate && make build to regenerate code and test
- Update
CHANGELOG.md under ## [Unreleased] → ### Added
- Update
README.md resource status table
- Submit PR using the template in
.github/PULL_REQUEST_TEMPLATE.md
For update-resource contributions:
- Find current definition:
grep -A 15 '"name": "azurerm_<name>"' resourceDefinition.json
- Research current Azure naming rules
- Update the entry in
resourceDefinition.json
- Run
go generate && make build
- Update
CHANGELOG.md under ## [Unreleased] → ### Changed
- Submit PR
For bug-fix contributions:
- Reproduce the bug with a test case
- Fix the code
- Verify fix with
make build
- Update
CHANGELOG.md under ## [Unreleased] → ### Fixed
- Submit PR
For docs contributions:
- Edit files under
docs/ or README.md
- Verify markdown renders correctly
- Submit PR
3. Reference
Point the contributor to:
.github/CONTRIBUTING.md for full guidelines
.github/PULL_REQUEST_TEMPLATE.md for the PR checklist
TESTING.md for test instructions