Skip to content

Commit 623e1d3

Browse files
committed
Update contributing guide
Signed-off-by: Timo Sand <[email protected]>
1 parent 74d23d8 commit 623e1d3

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ Before submitting an issue or a pull request, please search the repository for e
1313
1. Fork and clone the repository.
1414
2. Create a new branch: `git switch -c my-branch-name`.
1515
3. Make your change, add tests, and make sure the tests still pass.
16-
4. Push to your fork and submit a pull request.
17-
5. Pat yourself on the back and wait for your pull request to be reviewed and merged.
16+
4. Run `make fmt; make lint; make tf-provider-lint` to check for formatting, linting, and provider linting errors.
17+
5. Push to your fork and submit a pull request.
18+
6. Pat yourself on the back and wait for your pull request to be reviewed and merged.
1819

1920
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
2021

@@ -33,9 +34,9 @@ This section describes a typical sequence performed when developing locally. Ful
3334
Once you have the repository cloned, there's a couple of additional steps you'll need to take. Since most of the testing is acceptance or integration testing, we need to manipulate real GitHub resources in order to run it. Useful setup steps are listed below:
3435

3536
- If you haven't already, [create a GitHub organization you can use for testing](#github-organization).
36-
- Optional: you may find it beneficial to create a test user as well in order to avoid potential rate-limiting issues on your main account.
37-
- Your organization _must_ have a repository called `terraform-template-module`. The [terraformtesting/terraform-template-module](https://github.com/terraformtesting/terraform-template-module) repo is a good, re-usable example.
38-
- You _must_ make sure that the "Template Repository" item in Settings is checked for this repo.
37+
- Optional: you may find it beneficial to create a test user as well in order to avoid potential rate-limiting issues on your main account.
38+
- Your organization _must_ have a repository called `terraform-template-module`. The [terraformtesting/terraform-template-module](https://github.com/terraformtesting/terraform-template-module) repo is a good, re-usable example.
39+
- You _must_ make sure that the "Template Repository" item in Settings is checked for this repo.
3940
- If you haven't already, generate a Personal Access Token (PAT) for authenticating your test runs.
4041
- Export the necessary configuration for authenticating your provider with GitHub
4142

@@ -52,7 +53,7 @@ Once you have the repository cloned, there's a couple of additional steps you'll
5253
### Local Development Iteration
5354

5455
1. Write a test describing what you will fix. See [`github_label`](./github/resource_github_issue_label_test.go) for an example format.
55-
1. Run your test and observe it fail. Enabling debug output allows for observing the underlying requests and responses made as well as viewing state (search `STATE:`) generated during the acceptance test run.
56+
2. Run your test and observe it fail. Enabling debug output allows for observing the underlying requests and responses made as well as viewing state (search `STATE:`) generated during the acceptance test run.
5657

5758
```sh
5859
TF_LOG=DEBUG TF_ACC=1 go test -v ./... -run ^TestAccGithubIssueLabel

0 commit comments

Comments
 (0)