Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updates to CONTRIBUTING for Acceptance Test guidance #203

Merged
merged 2 commits into from
Dec 3, 2024
Merged

updates to CONTRIBUTING for Acceptance Test guidance #203

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ab0413
updates to CONTRIBUTING for Acceptance Test guidance
jlacefie Dec 3, 2024
9f53bd5
Merge branch 'main' into jlacefie/contguid
briankassouf Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,15 @@ We welcome all PRs. Before submitting a PR, please ensure that:
- Your code changes are well-tested.
- The PR includes a clear description of what you're addressing and why.
- If the PR introduces new functionality, appropriate tests are added.
- Run Acceptance Tests locally before submitted a non-Draft PR to ensure they pass. See the Running Tests section located below for details.

Feel free to submit a draft PR early if you need feedback or assistance during the development process. This can help identify potential improvements or issues early on.

Note: When you submit your first PR, you will be asked to sign the [Temporal Contributor License Agreement (CLA)](https://gist.github.com/samarabbas/7dcd41eb1d847e12263cc961ccfdb197) before we merge your PR.

Note 2: The Temporal Terraform Provider repo uses an automated test suite to run Acceptance Tests using an API Key. For security reasons, PR contributed by non Temporal team members aren't able to run the automated test suite. Before your PR is merged, a Temporal team member will likely run Acceptance Tests locally and may fork your PR in the process and resubmit the PR using the Temporal created fork.


## Issues and Pull Requests Lifecycle

- **Issues**: This is an open source project. Issues can be resolved by any community member. The maintainers of this project do triage issues regularly to ensure the issue is clear and tagged appropriately. If more information is needed, we will ask for further clarification. We encourage discussion to clarify the problem or refine solutions.
Expand Down Expand Up @@ -71,6 +75,8 @@ This will install the provider binary in your `$GOPATH/bin` directory.

### Running Tests

The following is guidance for running tests with the TF Provider.

#### Unit Tests

Unit tests should be executed frequently to ensure the quality of your contributions. Run the following command to execute the tests:
Expand Down
Loading