Skip to content

Commit

Permalink
Code formatting guidelines in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dr-orlovsky committed Apr 12, 2021
1 parent aa5c003 commit e44ef39
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,21 @@ grammar fixes.

### Formatting

We plan to utilize `rustfmt` for keeping the code formatting consistent.
However, this will be a gradual process since a thorough peer review is required
to make sure that no unintended changes are introduced with the change of
formatting. Thus, all PRs introducing large blocks of re-formatted code will not
be reviewed.

The current plan is to phase it in over multiple commits or even multiple PRs,
which will introduce no other changes that re-formatting, such that each change
may be independently re-reproduced by each reviewer. The first commit should add
attributes to disable fmt for some parts of the code and a second one does the
formatting – so only the first one needs review, the rest will be reproducible.

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)

<!--
Rust-fmt should be used as a coding style recommendations in general, with a
default coding style. By default, Rustfmt uses a style which conforms to the
Expand Down

0 comments on commit e44ef39

Please sign in to comment.