You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,9 @@ Before submitting an issue or a pull request, please search the repository for e
13
13
1. Fork and clone the repository.
14
14
2. Create a new branch: `git switch -c my-branch-name`.
15
15
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.
18
19
19
20
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
20
21
@@ -33,9 +34,9 @@ This section describes a typical sequence performed when developing locally. Ful
33
34
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:
34
35
35
36
- 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.
39
40
- If you haven't already, generate a Personal Access Token (PAT) for authenticating your test runs.
40
41
- Export the necessary configuration for authenticating your provider with GitHub
41
42
@@ -52,7 +53,7 @@ Once you have the repository cloned, there's a couple of additional steps you'll
52
53
### Local Development Iteration
53
54
54
55
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.
56
57
57
58
```sh
58
59
TF_LOG=DEBUG TF_ACC=1 go test -v ./... -run ^TestAccGithubIssueLabel
0 commit comments