openharmony/third_party_rust_bindgen
1
0
Fork 0
mirror of https://gitee.com/openharmony/third_party_rust_bindgen synced 2024-12-04 05:22:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md to talk about rustfmt in CI

Browse Source
This commit is contained in:
Nick Fitzgerald 2017-02-03 12:44:41 -08:00
parent 42d8133c39
commit 50dc79237b
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@ -114,24 +114,26 @@ $ cargo test -p tests_expectations
## Automatic code formatting
There's a `rustfmt.toml` file in the repo. Ideally changes should be consistent
with the style, though that's not enforced right now.
We use [`rustfmt`](https://github.com/rust-lang-nursery/rustfmt) to enforce a
consistent code style across the whole `bindgen` code base. This is enforced in
CI, and your pull requests will get automatically rejected if you don't
re-format with the latest `rustfmt` before pushing.
[`rustfmt`](https://github.com/rust-lang-nursery/rustfmt) can catch and fix
automatically all the coding style issues it finds. In order to use it it
suffices to do:
You can install the latest version of `rustfmt` with this command:
```
$ cargo install -f rustfmt
```
Ensure that `~/.cargo/bin` is on your path.
Once that is taken care of, you can (re)format all code by running this command:
```
$ cargo fmt
```
For it to work, you need to have `rustfmt` installed. To do so:
```
$ cargo install rustfmt
```
And ensure `~/.cargo/bin` is on your path.
The code style is described in the `rustfmt.toml` file in top level of the repo.
## Debug Logging