Skip to content

docs: suggest moving most PR checklist items to contributing guide#492

Merged
ValuedMammal merged 1 commit into
bitcoindevkit:masterfrom
noahjoeris:core/pr-template
Jun 4, 2026
Merged

docs: suggest moving most PR checklist items to contributing guide#492
ValuedMammal merged 1 commit into
bitcoindevkit:masterfrom
noahjoeris:core/pr-template

Conversation

@noahjoeris
Copy link
Copy Markdown
Contributor

@noahjoeris noahjoeris commented May 27, 2026

Description

Suggests moving most pull request checklist items from the PR template into CONTRIBUTING.md, keeping checklist minimal.

This follows the approach we added in bdk-tx recently.

Also fixes the contribution guidelines link in the PR template, which previously pointed at the bdk repo instead of this repo's CONTRIBUTING.md.

Notes to the reviewers

This is just a proposal, let me know if you like it.

Before submitting

@ValuedMammal ValuedMammal added chore Non-coding related work documentation Improvements or additions to documentation labels May 27, 2026
@ValuedMammal ValuedMammal moved this to In Progress in BDK Wallet May 27, 2026
@ValuedMammal ValuedMammal added this to the Wallet 3.1.0 milestone May 27, 2026
Comment thread CONTRIBUTING.md Outdated
@ValuedMammal
Copy link
Copy Markdown
Collaborator

CONTRIBUTING.md still says to use cargo fmt with the default settings, although to be clear we have since switched to cargo +nightly fmt.

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.93%. Comparing base (39de6ed) to head (879b986).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #492   +/-   ##
=======================================
  Coverage   80.93%   80.93%           
=======================================
  Files          24       24           
  Lines        5482     5482           
  Branches      247      247           
=======================================
  Hits         4437     4437           
  Misses        968      968           
  Partials       77       77           
Flag Coverage Δ
rust 80.93% <ø> (ø)

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
Copy link
Copy Markdown
Contributor Author

Thanks for catching that. Updated.

Copy link
Copy Markdown
Collaborator

@ValuedMammal ValuedMammal left a comment

Choose a reason for hiding this comment

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

ACK 879b986

@ValuedMammal ValuedMammal moved this from In Progress to Needs Review in BDK Wallet Jun 4, 2026
@ValuedMammal ValuedMammal merged commit d8e006f into bitcoindevkit:master Jun 4, 2026
18 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Review to Done in BDK Wallet Jun 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Non-coding related work documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants