Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc/contributing: rustfmt +nightly, prerequisites section #2449

Merged
merged 2 commits into from
Mar 19, 2023
Merged

doc/contributing: rustfmt +nightly, prerequisites section #2449

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cef059
add(doc/contributing): rustfmt +nightly, prerequisites section
amanjeev Mar 19, 2023
267d17a
update(doc/contributing): doctoc update
amanjeev Mar 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ and introduce yourself.
- [Code of Conduct](#code-of-conduct)
- [Filing an Issue](#filing-an-issue)
- [Looking to Start Contributing to `bindgen`?](#looking-to-start-contributing-to-bindgen)
- [Prerequisites](#prerequisites)
- [`rustfmt` / `cargo fmt`](#rustfmt--cargo-fmt)
- [Building](#building)
- [Testing](#testing)
- [Overview](#overview)
Expand Down Expand Up @@ -63,6 +65,16 @@ issue, provide us with:
* [Issues labeled "help wanted"](https://github.com/rust-lang/rust-bindgen/labels/help%20wanted)
* Still can't find something to work on? [Drop a comment here](https://github.com/rust-lang/rust-bindgen/issues/747)

## Prerequisites

### `rustfmt` / `cargo fmt`

We use `nightly` channel for `rustfmt` so please set the appropriate setting your editor/IDE for that.

For rust-analyzer, you can set `rustfmt.extraArgs = ['+nightly']`.

To check via command line, you can run `cargo +nightly fmt --check`.

## Building

To build the `bindgen` library and the `bindgen` executable:
Expand Down