This pull request includes substantial updates to the DEVELOPER.md file to improve the developer experience and provide clearer instructions. The changes focus on providing more detailed instructions for setting up a tenant, running the provider locally in VSCode, writing tests, and the developer workflow.
Tenant Setup:
DEVELOPER.md: Updated the section on tenant setup to provide more detailed instructions for developers. This includes setting up access to the tenant and authenticating to the provider once the tenant is set up.
Running Provider Locally:
DEVELOPER.md: Provided instructions for running the provider locally in VSCode or the operating system terminal. Also included notes on running terraform init and terraform plan when using dev overrides.
Writing Tests:
DEVELOPER.md: Added a comprehensive section on writing unit and acceptance tests. This includes creating happy path tests, mocking HTTP requests, and writing tests against real infrastructure.
Developer Workflow:
DEVELOPER.md: Included a detailed developer workflow for contributing to the repository. This includes instructions for forking the repository, working in the devcontainer, adding and updating tests, creating and updating examples, regenerating the docs, and raising a pull request.
Other Changes:
DEVELOPER.md: Made minor updates to the sections on adding dependencies and making a release. [1][2]
This pull request includes substantial updates to the
DEVELOPER.mdfile to improve the developer experience and provide clearer instructions. The changes focus on providing more detailed instructions for setting up a tenant, running the provider locally in VSCode, writing tests, and the developer workflow.Tenant Setup:
DEVELOPER.md: Updated the section on tenant setup to provide more detailed instructions for developers. This includes setting up access to the tenant and authenticating to the provider once the tenant is set up.Running Provider Locally:
DEVELOPER.md: Provided instructions for running the provider locally in VSCode or the operating system terminal. Also included notes on runningterraform initandterraform planwhen using dev overrides.Writing Tests:
DEVELOPER.md: Added a comprehensive section on writing unit and acceptance tests. This includes creating happy path tests, mocking HTTP requests, and writing tests against real infrastructure.Developer Workflow:
DEVELOPER.md: Included a detailed developer workflow for contributing to the repository. This includes instructions for forking the repository, working in the devcontainer, adding and updating tests, creating and updating examples, regenerating the docs, and raising a pull request.Other Changes:
DEVELOPER.md: Made minor updates to the sections on adding dependencies and making a release. [1] [2]