Merge pull request #223 from MalloZup/layout

Readme layout improvements

1 files changed, 27 insertions, 0 deletions

diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md
new file mode 100644
index 00000000..ddde4637
--- /dev/null
+++ b/doc/CONTRIBUTING.md
@@ -0,0 +1,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 ./...
+```