From b7eea6cb2669bd482a007f1c54636d9928549a69 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Tue, 26 Jul 2022 10:55:44 +1000 Subject: [PATCH] Update docs on rustfmt We have introduced `rustfmt` but forgot to update the docs section about it. Since a large portion of the codebase is currently ignored by our `rustfmt` configuration, point out that `rusntfmt` is work in progress. --- CONTRIBUTING.md | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a740475..7ee8ee8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -170,18 +170,9 @@ Library reflects Bitcoin Core approach whenever possible. ### Formatting -The repository currently does not use `rustfmt`. - -New changes may format the code with `rustfmt`, but they should not re-format -any existing code for maintaining diff size small, keeping `git blame` intact and -reduce review time. Repository maintainers may not review PRs introducing large -blocks of re-formatted code. - -You may check the [discussion on the formatting](https://github.com/rust-bitcoin/rust-bitcoin/issues/172) -and [how it is planned to coordinate it with crate refactoring](https://github.com/rust-bitcoin/rust-bitcoin/pull/525) - -For the new code it is recommended to follow style of the existing codebase and -avoid any end-line space characters. +The repository currently does use `rustfmt`. The introduction of this is still +WIP (see 'ignore' in `rustfmt.toml`) but we are working towards full +formatting. ### MSRV