By participating in this project, you agree to abide by the CODE OF CONDUCT.
OpenVMM uses the “fork-and-pull” development model. See GitHub forks for more information on forks. Please follow these steps to merge your changes to OpenVMM:
- Fork and clone the OpenVMM repo.
- Create a branch for your changes, develop your code and push your changes.
- Create a PR against the main branch of the OpenVMM repository from your fork.
- Go through the PR review process.
Following our coding conventions and writing a descriptive commit message will increase the chance that a PR is accepted.
We strongly suggest asking for feedback before starting to work on a new feature, functionality, etc. so that we can provide feedback and discuss how we can collaborate on this and support contributors.
To engage with project maintainers, contributors can reach out on Zulip (link coming soon) and then start drafting a GitHub issue after getting some preliminary feedback on Zulip, or they can open a GitHub issue to get preliminary feedback on GitHub and then reach out to us on Zulip to get some more synchronous support.
We normally use Zulip for more informal conversations and GitHub Issues for more formal, auditable, public discussion and progress tracking. We encourage contributors to use both in either order based on preference.