Only use two newlines before level 2 headings
In an attempt help maintain visual structure only use two newlines before level 2 headings.
This commit is contained in:
parent
9be2fb6088
commit
42e10ff132
|
@ -8,7 +8,6 @@ implementation and other Rust Bitcoin-related projects, which are hosted in the
|
||||||
mostly guidelines, not rules. Use your best judgment, and feel free to propose
|
mostly guidelines, not rules. Use your best judgment, and feel free to propose
|
||||||
changes to this document in a pull request.
|
changes to this document in a pull request.
|
||||||
|
|
||||||
|
|
||||||
#### Table Of Contents
|
#### Table Of Contents
|
||||||
|
|
||||||
- [General](#general)
|
- [General](#general)
|
||||||
|
@ -138,7 +137,6 @@ NB: Please keep in mind that the script above replaces `Cargo.lock` file, which
|
||||||
is necessary to support current MSRV, incompatible with `stable` and newer cargo
|
is necessary to support current MSRV, incompatible with `stable` and newer cargo
|
||||||
versions.
|
versions.
|
||||||
|
|
||||||
|
|
||||||
### Peer review
|
### Peer review
|
||||||
|
|
||||||
Anyone may participate in peer review which is expressed by comments in the pull
|
Anyone may participate in peer review which is expressed by comments in the pull
|
||||||
|
@ -147,7 +145,6 @@ test out the patch set and opine on the technical merits of the patch. Please,
|
||||||
first review PR on the conceptual level before focusing on code style or
|
first review PR on the conceptual level before focusing on code style or
|
||||||
grammar fixes.
|
grammar fixes.
|
||||||
|
|
||||||
|
|
||||||
### Repository maintainers
|
### Repository maintainers
|
||||||
|
|
||||||
Pull request merge requirements:
|
Pull request merge requirements:
|
||||||
|
@ -172,7 +169,6 @@ Current list of the project maintainers:
|
||||||
|
|
||||||
Library reflects Bitcoin Core approach whenever possible.
|
Library reflects Bitcoin Core approach whenever possible.
|
||||||
|
|
||||||
|
|
||||||
### Formatting
|
### Formatting
|
||||||
|
|
||||||
The repository currently does not use `rustfmt`.
|
The repository currently does not use `rustfmt`.
|
||||||
|
@ -188,14 +184,12 @@ and [how it is planned to coordinate it with crate refactoring](https://github.c
|
||||||
For the new code it is recommended to follow style of the existing codebase and
|
For the new code it is recommended to follow style of the existing codebase and
|
||||||
avoid any end-line space characters.
|
avoid any end-line space characters.
|
||||||
|
|
||||||
|
|
||||||
### MSRV
|
### MSRV
|
||||||
|
|
||||||
The Minimal Supported Rust Version (MSRV) is 1.29; it is enforced by our CI.
|
The Minimal Supported Rust Version (MSRV) is 1.29; it is enforced by our CI.
|
||||||
Later we plan to increase MSRV to support Rust 2018 and you are welcome to check
|
Later we plan to increase MSRV to support Rust 2018 and you are welcome to check
|
||||||
the [tracking issue](https://github.com/rust-bitcoin/rust-bitcoin/issues/510).
|
the [tracking issue](https://github.com/rust-bitcoin/rust-bitcoin/issues/510).
|
||||||
|
|
||||||
|
|
||||||
### Naming conventions
|
### Naming conventions
|
||||||
|
|
||||||
Naming of data structures/enums and their fields/variants must follow names used
|
Naming of data structures/enums and their fields/variants must follow names used
|
||||||
|
@ -204,7 +198,6 @@ in Bitcoin Core, with the following exceptions:
|
||||||
snake_case for fields and variants);
|
snake_case for fields and variants);
|
||||||
- omit `C`-prefixes.
|
- omit `C`-prefixes.
|
||||||
|
|
||||||
|
|
||||||
### Unsafe code
|
### Unsafe code
|
||||||
|
|
||||||
Use of `unsafe` code is prohibited unless there is a unanimous decision among
|
Use of `unsafe` code is prohibited unless there is a unanimous decision among
|
||||||
|
|
Loading…
Reference in New Issue