0
0
mirror of https://github.com/bpg/terraform-provider-proxmox.git synced 2025-07-02 03:22:59 +00:00

Additional community templates

This commit is contained in:
Dan Petersen 2019-12-30 20:50:58 +01:00
parent 0847544305
commit 09f3799d4e
2 changed files with 30 additions and 5 deletions

29
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,29 @@
# How to contribute
**First:** if you're unsure or afraid of _anything_, ask for help! You can
submit a work in progress (WIP) pull request, or file an issue with the parts
you know. We'll do our best to guide you in the right direction, and let you
know if there are guidelines we will need to follow. We want people to be able
to participate without fear of doing the wrong thing.
Below are our expectations for contributors. Following these guidelines gives us
the best opportunity to work with you, by making sure we have the things we need
in order to make it happen. Doing your best to follow it will speed up our
ability to merge PRs and respond to issues.
## Testing
The project has a handful of test cases which must pass for a contribution to be
accepted. We also expect that you either create new test cases or modify
existing ones in order to target your changes.
You can run all the test cases by invoking `make test`.
## Submitting changes
Please create a new PR against the `master` which must be based on the project's
[pull request template](.github/PULL_REQUEST_TEMPLATE.md).
## Coding conventions
We expect that all code contributions have been formatted using `gofmt`.

View File

@ -451,11 +451,7 @@ $ $GOPATH/bin/terraform-provider-proxmox
...
```
If you wish to contribute to the provider, the following requirements must be met,
* All tests must pass using `make test`
* The Go code must be formatted using Gofmt
* Dependencies are installed by `make init`
If you wish to contribute to the provider, please see [CONTRIBUTING.md](CONTRIBUTING.md)
## Testing the Provider
In order to test the provider, you can simply run `make test`.