Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 2.21 KB

Contributing to Rust Hypervisor Firmware

Rust Hypervisor Firmware is an open source project licensed under the Apache v2 License.

Coding Style

We follow the Rust Style convention and enforce it through the Continuous Integration (CI) process calling into rustfmt for each submitted Pull Request (PR).

Certificate of Origin

In order to get a clear contribution chain of trust we use the [signed-off-by language] (https://01.org/community/signed-process) used by the Linux kernel project.

Patch format

Beside the signed-off-by footer, we expect each patch to comply with the following format:

<component>: Change summary

More detailed explanation of your changes: Why and how.
Wrap it to 72 characters.
See http://chris.beams.io/posts/git-commit/
for some more good pieces of advice.

Signed-off-by: <[email protected]>

For example:

commit 6e9477ba25ac09cc6d918e6512b9eb4e0fb5a2a5
Author: Rob Bradford <[email protected]>
Date:   Wed May 1 17:30:51 2019 +0100

    block: Partially split VirtioMMIOBlockDevice
    
    Create a new trait called VirtioTransport and create a
    VirtioMMIOTransport that implements that trait moving all the virtio
    MMIO register updates into that. This means the block code is somewhat
    independent of MMIO.
    
    Signed-off-by: Rob Bradford <[email protected]>

Pull requests

Rust Hypervisor Firmware uses the “fork-and-pull” development model. Follow these steps if you want to merge your changes to the project`:

  1. Fork the rust-hypervisor-firmware project into your github organization.
  2. Within your fork, create a branch for your contribution.
  3. Create a pull request against the master branch of the repository.
  4. Once the pull request is approved, one of the maintainers will merge it.

Issue tracking

If you have a problem, please let us know. We recommend using github issues for formally reporting and documenting them.