virtiofsd/CONTRIBUTING.md

Contributing to virtiofsd

virtiofsd is an open source project licensed under the Apache v2 License and the BSD 3 Clause 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 used by the Linux kernel project.

Patch format

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

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: <contributor@foo.com>

For example:

Implement support for optional sandboxing
    
Implement support for setting up a sandbox for running the
service. The technique for this has been borrowed from virtiofsd, and
consists on switching to new PID, mount and network namespaces, and
then switching root to the directory to be shared.
   
Future patches will implement additional hardening features like
dropping capabilities and seccomp filters.
  
Signed-off-by: Sergio Lopez <slp@redhat.com>

Pull requests

virtiofsd uses the “fork-and-merge” development model. Follow these steps if you want to merge your changes to virtiofsd:

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

Issue tracking

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

You can also contact us via email through the virtio-fs mailing list.

Closing issues

You can either close issues manually by adding the fixing commit SHA1 to the issue comments or by adding the Fixes keyword to your commit message.

After the corresponding MR is merged, GitLab will automatically close that issue when parsing the commit message.