Skip to content

Commit 257c5f7

Browse files
committed
Merge #1584: docs: update CONTRIBUTING.md
6b881f8 docs: update CONTRIBUTING.md (valued mammal) Pull request description: Update `CONTRIBUTING.md` * Made small corrections and added some things that were missing. If there's something else you think should be included let me know. closes #1394 ### Changelog notice ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) ACKs for top commit: LagginTimes: ACK 6b881f8 notmandatory: ACK 6b881f8 storopoli: ACK 6b881f8 oleonardolima: ACK 6b881f8 Tree-SHA512: 9a000cb86800e8dac582e2bab06613c28111268fa343d8621181e8bf1b4859029704d1258392248449c36af9dd5ecf8ab25dadfe5bcf62e40e10719a575d3b64
2 parents f69eab6 + 6b881f8 commit 257c5f7

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ Every new feature should be covered by functional tests where possible.
4646
When refactoring, structure your PR to make it easy to review and don't
4747
hesitate to split it into multiple small, focused PRs.
4848

49-
The Minimal Supported Rust Version is **1.57.0** (enforced by our CI).
49+
The Minimum Supported Rust Version is **1.63.0** (enforced by our CI).
5050

5151
Commits should cover both the issue fixed and the solution's rationale.
52-
These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind. Commit messages should follow the ["Conventional Commits 1.0.0"](https://www.conventionalcommits.org/en/v1.0.0/) to make commit histories easier to read by humans and automated tools.
52+
These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind. Commit messages follow the ["Conventional Commits 1.0.0"](https://www.conventionalcommits.org/en/v1.0.0/) to make commit histories easier to read by humans and automated tools. All commits must be [GPG signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
5353

5454
To facilitate communication with other contributors, the project is making use
5555
of GitHub's "assignee" field. First check that no one is assigned and then
@@ -81,12 +81,19 @@ well as test out the patch set and opine on the technical merits of the patch.
8181
PR should be reviewed first on the conceptual level before focusing on code
8282
style or grammar fixes.
8383

84+
To merge a PR we require all CI tests to pass, the PR has at least one approving review by a maintainer with write access, and reasonable criticisms have been addressed.
85+
8486
Coding Conventions
8587
------------------
8688

8789
This codebase uses spaces, not tabs.
8890
Use `cargo fmt` with the default settings to format code before committing.
8991
This is also enforced by the CI.
92+
All public items must be documented. We adhere to the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/about.html) with respect to documentation.
93+
94+
The library is written using safe rust. Special consideration must be given to code which proposes an exception to the rule.
95+
96+
All new features require testing. Tests should be unique and self-describing. If a test is in development or is broken or no longer useful, then a reason should be given for adding the `#[ignore]` attribute.
9097

9198
Security
9299
--------

0 commit comments

Comments
 (0)