summary refs log tree commit diff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAlyssa Ross <hi@alyssa.is>2020-01-27 17:14:08 +0000
committerAlyssa Ross <hi@alyssa.is>2020-02-11 16:40:29 +0000
commit67b361d284a8cc94780f5797b4369df78a8278ac (patch)
treeaaccbdbb7fa0d704d43fb3a2681afcf33aeb582d /CONTRIBUTING.md
parentca5027323db6316ba242d98ddedd26350b06346e (diff)
downloadcrosvm-67b361d284a8cc94780f5797b4369df78a8278ac.tar
crosvm-67b361d284a8cc94780f5797b4369df78a8278ac.tar.gz
crosvm-67b361d284a8cc94780f5797b4369df78a8278ac.tar.bz2
crosvm-67b361d284a8cc94780f5797b4369df78a8278ac.tar.lz
crosvm-67b361d284a8cc94780f5797b4369df78a8278ac.tar.xz
crosvm-67b361d284a8cc94780f5797b4369df78a8278ac.tar.zst
crosvm-67b361d284a8cc94780f5797b4369df78a8278ac.zip
docs: make Markdown source more readable
Wrap long lines; use incrementing numbers in ordered lists rather than
making every item "1.".
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md32
1 files changed, 25 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 63ed15d..8889318 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,8 @@
 ## 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.
+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
 
@@ -9,32 +11,48 @@ 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.
+- 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.
+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.
+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:
+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`
+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.
+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.