mirror of
https://gitlab.com/virtio-fs/virtiofsd.git
synced 2025-11-27 19:10:33 +08:00
e81779754f
Replace all appearances of "virtiofsd-rs" with "virtiofsd". Signed-off-by: Sergio Lopez <slp@redhat.com>
73 lines
2.7 KiB
Markdown
73 lines
2.7 KiB
Markdown
# Contributing to virtiofsd
|
|
|
|
virtiofsd is an open source project licensed under the [Apache v2 License](https://opensource.org/licenses/Apache-2.0) and the [BSD 3 Clause](https://opensource.org/licenses/BSD-3-Clause) license.
|
|
|
|
## Coding Style
|
|
|
|
We follow the [Rust Style](https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md)
|
|
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:
|
|
|
|
```
|
|
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](https://gitlab.com/virtio-fs/virtiofsd) project
|
|
into your GitLab organization.
|
|
2. Within your fork, create a branch for your contribution.
|
|
3. [Create a merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
|
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](https://gitlab.com/virtio-fs/virtiofsd/-/issues/new) for formally
|
|
reporting and documenting them.
|
|
|
|
You can also contact us via email through the [virtio-fs mailing list](https://www.redhat.com/mailman/listinfo/virtio-fs).
|
|
|
|
## 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](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically).
|