Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#49)
Browse files Browse the repository at this point in the history
* Update CONTRIBUTING.md

* fmt
  • Loading branch information
matifali authored Sep 26, 2023
1 parent cb72a16 commit 1e3ac8b
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,15 @@ A suite of test-helpers exists to run `terraform apply` on modules with variable

Reference existing `*.test.ts` files for implementation.

```sh
```shell
# Run tests for a specific module!
$ bun test -t '<module>'
```

You can test a module locally by updating the source as follows

```hcl
source = "git::https://github.com/<USERNAME>/<REPO>.git//<MODULE-NAME>?ref=<BRANCH-NAME>"
```

> **Note:** This is the responsibility of the module author to implement tests for their module. and test the module locally before submitting a PR.

0 comments on commit 1e3ac8b

Please sign in to comment.