github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-26 11:39:29 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #214 from ManaSugi/add-rust-code-style

Browse Source 
docs: Add explanation about Rustlang coding style
This commit is contained in:
Fabiano Fidêncio 2021-05-19 22:54:51 +02:00 committed by GitHub
commit eaf4dd3336
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -6,6 +6,7 @@
* [Prerequisites](#prerequisites) * [Prerequisites](#prerequisites)
* [Contributor roles](#contributor-roles) * [Contributor roles](#contributor-roles)
* [Golang coding style](#golang-coding-style) * [Golang coding style](#golang-coding-style)
* [Rustlang coding style](#rustlang-coding-style)
* [Certificate of Origin](#certificate-of-origin) * [Certificate of Origin](#certificate-of-origin)
* [GitHub best practices](#github-best-practices) * [GitHub best practices](#github-best-practices)
* [Submit issues before PRs](#submit-issues-before-prs) * [Submit issues before PRs](#submit-issues-before-prs)
@ -78,6 +79,7 @@ To get started, complete the prerequisites below.
Special Git configuration is required for these contributors: Special Git configuration is required for these contributors:
* [Golang coding style](#golang-coding-style) * [Golang coding style](#golang-coding-style)
* [Rustlang coding style](#rustlang-coding-style)
* [Kata runtime static checks](#kata-runtime-static-checks) * [Kata runtime static checks](#kata-runtime-static-checks)
For all other contributor roles, follow the standard configuration, shown in For all other contributor roles, follow the standard configuration, shown in
@ -88,6 +90,18 @@ Prerequisites.
* Review [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments) to avoid common `Golang` errors. * Review [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments) to avoid common `Golang` errors.
* Use `gofmt` to fix any mechanical style issues. * Use `gofmt` to fix any mechanical style issues.
### Rustlang coding style
* Use `rustfmt` to fix any mechanical style issues. Rustfmt uses a style which conforms to the
[Rust Style Guide](https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md).
* Use `clippy` to catch common mistakes and improve your Rust code.
You can install the above tools as follows.
```sh
$ rustup component add rustfmt clippy
```
### Certificate of Origin ### Certificate of Origin
In order to get a clear contribution chain of trust we use the [signed-off-by In order to get a clear contribution chain of trust we use the [signed-off-by