@@ -8,6 +8,7 @@ implementation and other Rust Bitcoin-related projects, which are hosted in the
8
8
mostly guidelines, not rules. Use your best judgment, and feel free to propose
9
9
changes to this document in a pull request.
10
10
11
+
11
12
#### Table Of Contents
12
13
13
14
- [ General] ( #general )
@@ -97,6 +98,7 @@ comment suggesting that you're working on it. If someone is already assigned,
97
98
don't hesitate to ask if the assigned party or previous commenters are still
98
99
working on it if it has been awhile.
99
100
101
+
100
102
## Preparing PRs
101
103
102
104
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
136
138
is necessary to support current MSRV, incompatible with ` stable ` and newer cargo
137
139
versions.
138
140
141
+
139
142
### Peer review
140
143
141
144
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,
144
147
first review PR on the conceptual level before focusing on code style or
145
148
grammar fixes.
146
149
150
+
147
151
### Repository maintainers
148
152
149
153
Pull request merge requirements:
@@ -169,6 +173,7 @@ Current list of the project maintainers:
169
173
170
174
Library reflects Bitcoin Core approach whenever possible.
171
175
176
+
172
177
### Formatting
173
178
174
179
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
184
189
For the new code it is recommended to follow style of the existing codebase and
185
190
avoid any end-line space characters.
186
191
192
+
187
193
### MSRV
188
194
189
195
The Minimal Supported Rust Version (MSRV) is 1.29; it is enforced by our CI.
190
196
Later we plan to increase MSRV to support Rust 2018 and you are welcome to check
191
197
the [ tracking issue] ( https://github.com/rust-bitcoin/rust-bitcoin/issues/510 ) .
192
198
199
+
193
200
### Naming conventions
194
201
195
202
Naming of data structures/enums and their fields/variants must follow names used
@@ -198,6 +205,7 @@ in Bitcoin Core, with the following exceptions:
198
205
snake_case for fields and variants);
199
206
- omit ` C ` -prefixes.
200
207
208
+
201
209
### Unsafe code
202
210
203
211
Use of ` unsafe ` code is prohibited unless there is a unanimous decision among
0 commit comments