Skip to content

Commit 1900e2e

Browse files
committed
Merge #1871: docs: update CONTRIBUTING.md with section for new contributors
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
2 parents 739b54f + a3bc5dd commit 1900e2e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,21 @@ and good test coverage of the codebase is an important goal.
114114
Refactoring the project to enable fine-grained unit testing is also an ongoing
115115
effort.
116116

117+
First Time Contributors
118+
-----------------------
119+
120+
If it is your first time contributing to the BDK family of libraries, welcome! We're glad to have you with us. If your
121+
first (or few first) PRs are focused on very small fixes to documentation, however, they might not meet our threshold
122+
for acceptance for first time contributors.
123+
124+
Minor grammar and punctuation fixes aren't a good way to start contributing to a project, and instead we suggest you
125+
start with something a little more substantial. It's better to find an issue where you can demonstrate some knowledge
126+
of bitcoin or the code base, such as improving the substance of documentation, testing, or fixing some small issue
127+
even if it's considered low priority.
128+
129+
This being said we are always looking forward to working with new folks interested in contributing to our libraries.
130+
If you are looking for issues to work on, check out the good first issue label and join our Discord server!
131+
117132
Going further
118133
-------------
119134

0 commit comments

Comments
 (0)