Skip to content

Commit

Permalink
Merge #1584: docs: update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
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
  • Loading branch information
notmandatory committed Sep 5, 2024
2 parents f69eab6 + 6b881f8 commit 257c5f7
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ Every new feature should be covered by functional tests where possible.
When refactoring, structure your PR to make it easy to review and don't
hesitate to split it into multiple small, focused PRs.

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

Commits should cover both the issue fixed and the solution's rationale.
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.
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).

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

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.

Coding Conventions
------------------

This codebase uses spaces, not tabs.
Use `cargo fmt` with the default settings to format code before committing.
This is also enforced by the CI.
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.

The library is written using safe rust. Special consideration must be given to code which proposes an exception to the rule.

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.

Security
--------
Expand Down

0 comments on commit 257c5f7

Please sign in to comment.