Skip to content

docs: add maintainers section to CONTRIBUTING.md - #2328

Merged
notmandatory merged 1 commit into
bitcoindevkit:masterfrom
notmandatory:docs/update_contributing
Sep 29, 2026
Merged

notmandatory merged 1 commit into
bitcoindevkit:masterfrom
notmandatory:docs/update_contributing

Conversation

@notmandatory

Copy link
Copy Markdown
Member

Description

I borrowed from the rust-bitcoin CONTRIBUTING.md file to add a maintainers section to our CONTRIBUTING.md file. The main points I wanted to clarify are:

  1. a maintainer can merge a PR based on the reviews of other project contributors they trust to competently review and test changes. They do not need to do a detailed review and test each and every PR themselves.
  2. a maintainer must ensure "rough consensus" is reached on the need for and correctness of a PR.
  3. at least one maintainers must ACK a PR who is not the original author.

Notes to the reviewers

These changes match recent bitcoindevkit/bdk_wallet#521 and I'll propose the same change on our other repos.

Changelog notice

  • Add maintainers section to CONTRIBUTING.md file.

Before submitting

@codecov

codecov Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.84%. Comparing base (e417c43) to head (081e038).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2328   +/-   ##
=======================================
  Coverage   78.84%   78.84%           
=======================================
  Files          31       31           
  Lines        6060     6060           
  Branches      288      288           
=======================================
  Hits         4778     4778           
  Misses       1203     1203           
  Partials       79       79           
Flag Coverage Δ
rust 78.84% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@noahjoeris noahjoeris left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK fcf1e44

Comment thread CONTRIBUTING.md Outdated
@notmandatory
notmandatory force-pushed the docs/update_contributing branch from fcf1e44 to 081e038 Compare September 29, 2026 20:38
@noahjoeris

Copy link
Copy Markdown
Contributor

reACK 081e038

@notmandatory notmandatory moved this to Needs Review in BDK Chain Sep 29, 2026
@notmandatory
notmandatory merged commit 081e038 into bitcoindevkit:master Sep 29, 2026
19 checks passed
@notmandatory notmandatory self-assigned this Sep 29, 2026
@notmandatory notmandatory added the documentation Improvements or additions to documentation label Sep 29, 2026
noahjoeris added a commit to bitcoindevkit/bdk_wallet that referenced this pull request Sep 30, 2026
284fb1e docs(fix): fix spelling of consensus in CONTRIBUTING.md (Steve Myers)

Pull request description:

  ### Description

  Small change to fix misspelling of "consensus" in #521.

  ### Notes to the reviewers

  I've installed `harper-ls` in my new editor (helix) to catch spelling errors sooner.

  @noahjoeris caught this typo in bitcoindevkit/bdk#2328.

  ### Before submitting

  - [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk_wallet/blob/master/CONTRIBUTING.md)
  - [ ] This PR breaks the existing API

ACKs for top commit:
  noahjoeris:
    ACK 284fb1e

Tree-SHA512: dc29237356220f75f6b683390195b682edcd933ee9a90278e8a7fd5b5b50876d43e23c77e35bf14d63e465965bcf482f5df16f64b7a05c5ecf8e40e0721680a8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants