Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

60 lines (43 loc) · 3.76 KB

Release release-date contributors commit-activity License

How to contribute to PacketFabric Terraform Provider

Did you find a bug?

  • 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.

Did you write a patch that fixes a bug?

  • 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.

Do you intend to add a new feature or change an existing one?

  • 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 under internal/packetfabric and update test_* under internal/testutil
      • using real data <resource_name>_test.go under internal/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)
    • Add/Update examples under examples/resources and/or examples/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 under docs/
    • Find more details on the Readme
    • To see the debug logs, set TF_LOG=DEBUG and comment out c.Ctx = context.Background() in internal/packetfabric/client.go before you build the provider.
  • 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.

Do you have questions about the source code or the provider in general?

  • Ask any question here.

Thanks! 🚀 😄

The PacketFabric Team