-
Ensure the bug was not already reported by searching on GitHub under Issues.
-
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a Terraform code sample or an executable test case demonstrating the expected behavior that is not occurring.
-
Open a new GitHub pull request with the patch.
-
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
-
Open a new feature request, start writing code and submit it for review.
-
Adding or Updating existing Terraform resources/data-sources consists of:
- Add/Update Terraform Go Code located under the
internal
folder - Add/Update Tests
- using mock data
<file>_test.go
underinternal/packetfabric
and updatetest_*
underinternal/testutil
- using real data
<resource_name>_test.go
underinternal/provider
(see ACC) - add one of the following build tag in the
<file>_test.go
- all
- smoke
- resource
- datasource
- cloud_router
- hosted_cloud
- dedicated_cloud
- core (includes port, vc, ptp)
- marketplace
- other (user, event streaming, documents)
- using mock data
- Add/Update examples under
examples/resources
and/orexamples/data-sources
(used for the documentation) - Add/Update the templates used to generate the docs under
templates
- Generate the docs using tfplugindocs, from the root execute:
- Run
./tfplugindocs.sh
- Verify each
*.md
underdocs/
- Run
- Find more details on the Readme
- To see the debug logs, set
TF_LOG=DEBUG
and comment outc.Ctx = context.Background()
ininternal/packetfabric/client.go
before you build the provider.
- Add/Update Terraform Go Code located under the
-
Create your own branch with your updates including code changes, test, examples and documentation.
-
Make sure you test it locally, then create a PR so it can be reviewed by our team.
- Ask any question here.
Thanks! 🚀 😄
The PacketFabric Team