diff options
| author | Glyn Normington <gnormington@pivotal.io> | 2017-09-04 07:46:32 +0100 |
|---|---|---|
| committer | Glyn Normington <gnormington@pivotal.io> | 2017-09-04 07:46:32 +0100 |
| commit | 24f26839f669e0930ca6e3292ce395153db8ff34 (patch) | |
| tree | c6258dd06f56c72b9ce9a63b4444151084fceb25 | |
| parent | e841f6f88d13298e8f0a6f64e00ccd6a9805cfd7 (diff) | |
Delete automatic code formatting guidelines
These are currently inaccurate as `cargo fmt` is not enforced for bindgen.
This section can be re-instated if and when code formatting is enforced.
| -rw-r--r-- | CONTRIBUTING.md | 24 |
1 files changed, 0 insertions, 24 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d33d367..d56ff777 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,6 @@ out to us in a GitHub issue, or stop by - [Testing a Single Header's Bindings Generation and Compiling its Bindings](#testing-a-single-headers-bindings-generation-and-compiling-its-bindings) - [Authoring New Tests](#authoring-new-tests) - [Test Expectations and `libclang` Versions](#test-expectations-and-libclang-versions) -- [Automatic code formatting](#automatic-code-formatting) - [Pull Requests and Code Reviews](#pull-requests-and-code-reviews) - [Generating Graphviz Dot Files](#generating-graphviz-dot-files) - [Debug Logging](#debug-logging) @@ -192,29 +191,6 @@ Where `$VERSION` is one of: depending on which version of `libclang` you have installed. -## Automatic code formatting - -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. - -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 -``` - -The code style is described in the `rustfmt.toml` file in top level of the repo. - ## Pull Requests and Code Reviews Ensure that each commit stands alone, and passes tests. This enables better `git |