9407d103c5 Be uniform in heading spacing (Tobin Harding)
af9389d724 Add Kixunil, RCassata, and tcharding to maintainers (Tobin Harding)

Pull request description:

  We recently added `CONTRIBUTING.md` but forgot to add @Kixunil . Also a couple days ago I was added to the repo.

  Patch two is trivial cleanup of whitespace.

ACKs for top commit:
  sanket1729:
    utACK 9407d103c5. Did not verify emails :)
  Kixunil:
    ACK 9407d103c5
  RCasatta:
    ACK 9407d103c5
  elichai:
    ACK 9407d103c5
  apoelstra:
    ACK 9407d103c5

Tree-SHA512: 032e847972a418a425f91364b8850a398f814406dc109f216cc783feefc7db9504e75c2f7f2d4b4d42b2bb44e7d4ef8c5641a7741389ce7ab2f9063d12afcc88
This commit is contained in:
Andrew Poelstra 2022-01-18 20:52:54 +00:00
commit fe5e6db70c
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
1 changed files with 11 additions and 0 deletions

View File

@ -8,6 +8,7 @@ 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
changes to this document in a pull request.
#### Table Of Contents
- [General](#general)
@ -97,6 +98,7 @@ comment suggesting that you're working on it. If someone is already assigned,
don't hesitate to ask if the assigned party or previous commenters are still
working on it if it has been awhile.
## Preparing PRs
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
is necessary to support current MSRV, incompatible with `stable` and newer cargo
versions.
### Peer review
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,
first review PR on the conceptual level before focusing on code style or
grammar fixes.
### Repository maintainers
Pull request merge requirements:
@ -160,12 +164,16 @@ Current list of the project maintainers:
- [Elichai Turkel](https://github.com/elichai)
- [Sebastian Geisler](https://github.com/sgeisler)
- [Sanket Kanjalkar](https://github.com/sanket1729)
- [Martin Habovštiak](https://github.com/Kixunil)
- [Riccardo Casatta](https://github.com/RCasatta)
- [Tobin Harding](https://github.com/tcharding)
## Coding conventions
Library reflects Bitcoin Core approach whenever possible.
### Formatting
The repository currently does not use `rustfmt`.
@ -181,12 +189,14 @@ 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
avoid any end-line space characters.
### MSRV
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
the [tracking issue](https://github.com/rust-bitcoin/rust-bitcoin/issues/510).
### Naming conventions
Naming of data structures/enums and their fields/variants must follow names used
@ -195,6 +205,7 @@ in Bitcoin Core, with the following exceptions:
snake_case for fields and variants);
- omit `C`-prefixes.
### Unsafe code
Use of `unsafe` code is prohibited unless there is a unanimous decision among