Skip to content

Commit

Permalink
Merge #1871: docs: update CONTRIBUTING.md with section for new contri…
Browse files Browse the repository at this point in the history
…butors

a3bc5dd docs: update CONTRIBUTING.md with section for new contributors (Steve Myers)

Pull request description:

  ### Description

  This makes the discussion in #1762 easier to find for new contributors.

  ### 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)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

Top commit has no ACKs.

Tree-SHA512: 3f092f2e9d6d3baee75fd5e9fc396d67dbabe9dd0a78d8bda12b2bd3cc21d54139bd542761cae83d41c444c2be4ead063b0382bfa53c1c74e07743347f510a55
  • Loading branch information
notmandatory committed Mar 6, 2025
2 parents 739b54f + a3bc5dd commit 1900e2e
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,21 @@ and good test coverage of the codebase is an important goal.
Refactoring the project to enable fine-grained unit testing is also an ongoing
effort.

First Time Contributors
-----------------------

If it is your first time contributing to the BDK family of libraries, welcome! We're glad to have you with us. If your
first (or few first) PRs are focused on very small fixes to documentation, however, they might not meet our threshold
for acceptance for first time contributors.

Minor grammar and punctuation fixes aren't a good way to start contributing to a project, and instead we suggest you
start with something a little more substantial. It's better to find an issue where you can demonstrate some knowledge
of bitcoin or the code base, such as improving the substance of documentation, testing, or fixing some small issue
even if it's considered low priority.

This being said we are always looking forward to working with new folks interested in contributing to our libraries.
If you are looking for issues to work on, check out the good first issue label and join our Discord server!

Going further
-------------

Expand Down

0 comments on commit 1900e2e

Please sign in to comment.