docs: Update CONTRIBUTING.md

This document does not reflect the way the project is run. Update it to
reflect that.

Signed-off-by: Rob Bradford <robert.bradford@intel.com>
This commit is contained in:
Rob Bradford 2022-05-18 17:15:52 +01:00
parent ea753b4f32
commit 5e7a77e5f9

View File

@ -2,12 +2,14 @@
Cloud Hypervisor is an open source project licensed under the [Apache v2 Cloud Hypervisor is an open source project licensed under the [Apache v2
License](https://opensource.org/licenses/Apache-2.0) and the [BSD 3 License](https://opensource.org/licenses/Apache-2.0) and the [BSD 3
Clause](https://opensource.org/licenses/BSD-3-Clause) license. Contributions Clause](https://opensource.org/licenses/BSD-3-Clause) license. Individual files
can be made under either license or both. Individual files contain details of contain details of their licensing and changes to that file are under the same
their licensing and changes to that file are under the same license unless the license unless the contribution changes the license of the file. When importing
contribution changes the license of the file. When importing code from a third code from a third party project (e.g. Firecracker or CrosVM) please respect the
party project (e.g. Firecracker or CrosVM) please respect the license of those license of those projects.
projects.
New code should be under the [Apache v2
License](https://opensource.org/licenses/Apache-2.0).
## Coding Style ## Coding Style
@ -63,11 +65,9 @@ you want to merge your changes to `cloud-hypervisor`:
2. Within your fork, create a branch for your contribution. 2. Within your fork, create a branch for your contribution.
3. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) 3. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
against the main branch of the Cloud Hypervisor repository. against the main branch of the Cloud Hypervisor repository.
4. Add reviewers to your pull request and then work with your reviewers to address 4. To update your pull request amend existing commits whenever applicable and
any comments and obtain minimum of 2 [maintainers](MAINTAINERS.md) approvals.
To update your pull request amend existing commits whenever applicable and
then push the new changes to your pull request branch. then push the new changes to your pull request branch.
5. Once the pull request is approved, one of the maintainers will merge it. 5. Once the pull request is approved it can be integrated.
## Issue tracking ## Issue tracking