Skip to content

Commit 9b6d3d9

Browse files
authored
doc/contributing: rustfmt +nightly, prerequisites section (#2449)
* add(doc/contributing): rustfmt +nightly, prerequisites section * update(doc/contributing): doctoc update
1 parent a101063 commit 9b6d3d9

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

+12
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ and introduce yourself.
1111
- [Code of Conduct](#code-of-conduct)
1212
- [Filing an Issue](#filing-an-issue)
1313
- [Looking to Start Contributing to `bindgen`?](#looking-to-start-contributing-to-bindgen)
14+
- [Prerequisites](#prerequisites)
15+
- [`rustfmt` / `cargo fmt`](#rustfmt--cargo-fmt)
1416
- [Building](#building)
1517
- [Testing](#testing)
1618
- [Overview](#overview)
@@ -63,6 +65,16 @@ issue, provide us with:
6365
* [Issues labeled "help wanted"](https://github.com/rust-lang/rust-bindgen/labels/help%20wanted)
6466
* Still can't find something to work on? [Drop a comment here](https://github.com/rust-lang/rust-bindgen/issues/747)
6567

68+
## Prerequisites
69+
70+
### `rustfmt` / `cargo fmt`
71+
72+
We use `nightly` channel for `rustfmt` so please set the appropriate setting your editor/IDE for that.
73+
74+
For rust-analyzer, you can set `rustfmt.extraArgs = ['+nightly']`.
75+
76+
To check via command line, you can run `cargo +nightly fmt --check`.
77+
6678
## Building
6779

6880
To build the `bindgen` library and the `bindgen` executable:

0 commit comments

Comments
 (0)