Skip to content

Commit 1bafe49

Browse files
committed
Be uniform in heading spacing
We currently sometimes have one newline before headings and sometimes two, its not important which it is but uniformity is nice. Use two newlines before headings uniformly in `CONTRIBUTING.md`.
1 parent e17d89a commit 1bafe49

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ implementation and other Rust Bitcoin-related projects, which are hosted in the
88
mostly guidelines, not rules. Use your best judgment, and feel free to propose
99
changes to this document in a pull request.
1010

11+
1112
#### Table Of Contents
1213

1314
- [General](#general)
@@ -97,6 +98,7 @@ comment suggesting that you're working on it. If someone is already assigned,
9798
don't hesitate to ask if the assigned party or previous commenters are still
9899
working on it if it has been awhile.
99100

101+
100102
## Preparing PRs
101103

102104
The main library development happens in the `master` branch. This branch must
@@ -136,6 +138,7 @@ NB: Please keep in mind that the script above replaces `Cargo.lock` file, which
136138
is necessary to support current MSRV, incompatible with `stable` and newer cargo
137139
versions.
138140

141+
139142
### Peer review
140143

141144
Anyone may participate in peer review which is expressed by comments in the pull
@@ -144,6 +147,7 @@ test out the patch set and opine on the technical merits of the patch. Please,
144147
first review PR on the conceptual level before focusing on code style or
145148
grammar fixes.
146149

150+
147151
### Repository maintainers
148152

149153
Pull request merge requirements:
@@ -169,6 +173,7 @@ Current list of the project maintainers:
169173

170174
Library reflects Bitcoin Core approach whenever possible.
171175

176+
172177
### Formatting
173178

174179
The repository currently does not use `rustfmt`.
@@ -184,12 +189,14 @@ and [how it is planned to coordinate it with crate refactoring](https://github.c
184189
For the new code it is recommended to follow style of the existing codebase and
185190
avoid any end-line space characters.
186191

192+
187193
### MSRV
188194

189195
The Minimal Supported Rust Version (MSRV) is 1.29; it is enforced by our CI.
190196
Later we plan to increase MSRV to support Rust 2018 and you are welcome to check
191197
the [tracking issue](https://github.com/rust-bitcoin/rust-bitcoin/issues/510).
192198

199+
193200
### Naming conventions
194201

195202
Naming of data structures/enums and their fields/variants must follow names used
@@ -198,6 +205,7 @@ in Bitcoin Core, with the following exceptions:
198205
snake_case for fields and variants);
199206
- omit `C`-prefixes.
200207

208+
201209
### Unsafe code
202210

203211
Use of `unsafe` code is prohibited unless there is a unanimous decision among

0 commit comments

Comments
 (0)