summaryrefslogtreecommitdiff
path: root/doc/CONTRIBUTING.md
blob: ddde4637b4c9ef1e9aeeeaa5f23eb5b3d57c5dd7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Where to start?

Look at open issues, especially with label:

- [junior job](https://github.com/dmacvicar/terraform-provider-libvirt/issues?q=is%3Aissue+is%3Aopen+label%3A%22junior+job%22), 
- [help wanted](https://github.com/dmacvicar/terraform-provider-libvirt/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)

# Contribute

1. [Build the plugin from source](https://github.com/dmacvicar/terraform-provider-libvirt#building-from-source)
2. If you have issues, check out the [troubleshooting](https://github.com/dmacvicar/terraform-provider-libvirt/blob/master/doc/TROUBLESHOOTING.md)
3. Do your code (reference issue on your pr if you fix them) [Closing issues keywords](https://help.github.com/articles/closing-issues-using-keywords/)
4. Run the acceptance tests.

## Writing acceptance tests.

https://github.com/hashicorp/terraform/blob/master/.github/CONTRIBUTING.md#running-an-acceptance-test

## Running acceptance tests 

You need to define the ```LIBVIRT_DEFAULT_URI``` and ```TF_ACC``` variables.

```console
export LIBVIRT_DEFAULT_URI=qemu:///system
export TF_ACC=1
go test ./...
```