1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
## Intro
This article goes into detail about multiple areas of interest to contributors,
which includes reviewers, developers, and integrators who each share an interest
in guiding crosvm's direction.
## Guidelines
The following is high level guidance for producing contributions to crosvm.
- Prefer mechanism to policy.
- Use existing protocols when they are adequate, such as virtio.
- Prefer security over code re-use and speed of development.
- Only the version of Rust in use by the Chrome OS toolchain is supported. This
is ordinarily the stable version of Rust, but can be behind a version for a
few weeks.
- Avoid distribution specific code.
## Code Health
### Scripts
In the `bin/` directory of the crosvm repository, there is the `clippy` script
which lints the Rust code and the `fmt` script which will format the crosvm Rust
code inplace. When submitting changes, the `bin/smoke_test` script, which checks
Rust format and unit tests, will be run by Kokoro, the internal Google run cloud
builder, and the results will be posted to the change. Kokoro is only
informational, so if Kokoro rejects a change, it can still be submitted.
### Submitting Code
See also, [Chrome OS Contributing Guide](https://chromium.googlesource.com/chromiumos/docs/+/master/contributing.md)
When a change is approved, verified, and added to the [commit queue](https://chromium.googlesource.com/chromiumos/docs/+/master/contributing.md#send-your-changes-to-the-commit-queue), crosvm will
be built and the unit tests (with some exceptions) will be run by the Chrome OS
infrastructure. Only if that passes, will the change be submitted. Failures here
will cause the commit queue to reject the change until it is re-added
(CQ+2). Unfortunately, it is extremely common for false negatives to cause a
change to get rejected, so be ready to re-apply the CQ+2 label if you're the
owner of a ready to submit change.
### Style guidelines
To format all code, crosvm defers to rustfmt. In addition, the code adheres to
the following rules:
The `use` statements for each module should be grouped in this order
1. `std`
2. third-party crates
3. chrome os crates
4. crosvm crates
5. `crate`
crosvm uses the [remain](https://github.com/dtolnay/remain) crate to keep error
enums sorted, along with the `#[sorted]` attribute to keep their corresponding
match statements in the same order.
|