Skip to content

Commit 270b9ff

Browse files
committed
Managed by Terraform: Add CONTRIBUTING.md issue template
1 parent b97510a commit 270b9ff

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

.github/CONTRIBUTING.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ contribute to the project, read on. This document will cover what we're looking
1111
for. By addressing all the points we're looking for, it raises the chances we
1212
can quickly merge or address your contributions.
1313

14-
When contributing in any way to the Packer project (new issue, PR, etc), please
15-
be aware that our team identifies with many gender pronouns. Please remember to
16-
use nonbinary pronouns (they/them) and gender neutral language ("Hello folks")
17-
when addressing our team. For more reading on our code of conduct, please see the
14+
When contributing in any way to the Packer project (new issue, PR, etc), please
15+
be aware that our team identifies with many gender pronouns. Please remember to
16+
use nonbinary pronouns (they/them) and gender neutral language ("Hello folks")
17+
when addressing our team. For more reading on our code of conduct, please see the
1818
[HashiCorp community guidelines](https://www.hashicorp.com/community-guidelines).
1919

2020
## Issues
@@ -53,7 +53,7 @@ when addressing our team. For more reading on our code of conduct, please see th
5353
linked.
5454

5555
5. Sometimes, if you have a specialized environment or use case, the maintainers
56-
may ask for your help testing the patch.
56+
may ask for your help testing the patch.
5757

5858
6. The issue is closed.
5959

@@ -80,9 +80,9 @@ adjust them for Windows or other shells.
8080
`$GOPATH/src/github.com/hashicorp/packer-plugin-hyperv`.
8181

8282
2. When working on the Hyperv plugin, first `cd $GOPATH/src/github.com/hashicorp/packer-plugin-hyperv`
83-
so you can run `make dev` and easily access other files. `make dev` will build the packer-plugin-hyperv binary and install it under `$HOME/.packer.d/plugins/`.
83+
so you can run `make dev` and easily access other files. `make dev` will build the packer-plugin-hyperv binary and install it under `$HOME/.packer.d/plugins/`.
8484

85-
3. Make your changes to the Hyperv plugin source. You can run `make dev` to build and install locally, and `make test` to run unit tests.
85+
3. Make your changes to the Hyperv plugin source. You can run `make dev` to build and install locally, and `make test` to run unit tests.
8686
Any compilation errors will be shown when the binaries are rebuilding. If you don't have `make` you can simply run `go build -o packer-plugin-hyperv` from the project root, and `mv packer-plugin-hyperv ~/.packer.d/plugins/packer-plugin-hyperv` to install the plugin.
8787

8888
4. After building the Hyperv plugin successfully, use the latest version of Packer to build a machine and verify your changes. In the [example folder](https://github.com/hashicorp/packer-plugin-hyperv/blob/main/example) we provide a basic template. Comment out the `packer {}` block to force Packer use the development binary installed in the previous step.
@@ -225,17 +225,19 @@ does not attempt to track the latest version for each dependency.
225225

226226
#### HCL2 Spec code generation
227227

228-
Packer relies on `go generate` to generate HCL2's bridging code. First you should install the command with `go install github.com/hashicorp/packer/cmd/mapstructure-to-hcl2`, then you generate with
228+
Packer relies on `go generate` to generate HCL2's bridging code. First you should install the command with `go install github.com/hashicorp/packer-plugin-sdk/cmd/packer-sdc@latest`, then you generate with
229229
`go generate ./...`. This should update/create `*.hcl2spec.go` file(s).
230230

231231
#### Running Unit Tests
232232

233-
You can run tests for individual packages using commands like this:
233+
To run unit tests, simply call
234234

235235
```
236-
make test TEST=./builder/ebs/...
236+
make test
237237
```
238238

239+
from the plugin's project root.
240+
239241
#### Running Builder Acceptance Tests
240242

241243
If the Hyperv Plugin has [acceptance tests](https://en.wikipedia.org/wiki/Acceptance_testing), these probably have some requirements such as environment variables to be set for API tokens and keys. Each test should error and tell you what are missing, so those are not documented here.
@@ -252,7 +254,7 @@ resources are not accidentally destroyed or overwritten during testing.
252254
To run the acceptance tests, invoke `make testacc`:
253255

254256
```
255-
make testacc TEST=./builder/ebs
257+
make testacc
256258
...
257259
```
258260

0 commit comments

Comments
 (0)