summaryrefslogtreecommitdiff
path: root/vendor/github.com/digitalocean/go-libvirt/CONTRIBUTING.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2021-03-15 14:52:43 -0500
committerbaude <bbaude@redhat.com>2021-03-25 08:43:51 -0500
commitb5f54a9b23e8d9418700494da9aa78d8db354c43 (patch)
tree59dfb9edf3faf6d184f6af40522f71968948133a /vendor/github.com/digitalocean/go-libvirt/CONTRIBUTING.md
parenta861f6fd3ebe4fe0b63a1b550e6b99d7525228c0 (diff)
downloadpodman-b5f54a9b23e8d9418700494da9aa78d8db354c43.tar.gz
podman-b5f54a9b23e8d9418700494da9aa78d8db354c43.tar.bz2
podman-b5f54a9b23e8d9418700494da9aa78d8db354c43.zip
introduce podman machine
podman machine allows podman to create, manage, and interact with a vm running some form of linux (default is fcos). podman is then configured to be able to interact with the vm automatically. while this is usable on linux, the real push is to get this working on both current apple architectures in macos. Ashley Cui contributed to this PR and was a great help. [NO TESTS NEEDED] Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'vendor/github.com/digitalocean/go-libvirt/CONTRIBUTING.md')
-rw-r--r--vendor/github.com/digitalocean/go-libvirt/CONTRIBUTING.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/vendor/github.com/digitalocean/go-libvirt/CONTRIBUTING.md b/vendor/github.com/digitalocean/go-libvirt/CONTRIBUTING.md
new file mode 100644
index 000000000..1b5b74106
--- /dev/null
+++ b/vendor/github.com/digitalocean/go-libvirt/CONTRIBUTING.md
@@ -0,0 +1,30 @@
+Contributing
+============
+
+The `go-libvirt` project makes use of the [GitHub Flow](https://guides.github.com/introduction/flow/)
+for contributions.
+
+If you'd like to contribute to the project, please
+[open an issue](https://github.com/digitalocean/go-libvirt/issues/new) or find an
+[existing issue](https://github.com/digitalocean/go-libvirt/issues) that you'd like
+to take on. This ensures that efforts are not duplicated, and that a new feature
+aligns with the focus of the rest of the repository.
+
+Once your suggestion has been submitted and discussed, please be sure that your
+code meets the following criteria:
+ - code is completely `gofmt`'d
+ - new features or codepaths have appropriate test coverage
+ - `go test ./...` passes
+ - `go vet ./...` passes
+ - `golint ./...` returns no warnings, including documentation comment warnings
+
+In addition, if this is your first time contributing to the `go-libvirt` project,
+add your name and email address to the
+[AUTHORS](https://github.com/digitalocean/go-libvirt/blob/master/AUTHORS) file
+under the "Contributors" section using the format:
+`First Last <email@example.com>`.
+
+Finally, submit a pull request for review!
+
+Questions? Feel free to join us in [`#go-qemu` on freenode](https://webchat.freenode.net/)
+if you'd like to discuss the project.