]> Untitled Git - bdk/commitdiff
docs: update CONTRIBUTING.md with section for new contributors
authorSteve Myers <steve@notmandatory.org>
Tue, 4 Mar 2025 16:43:17 +0000 (10:43 -0600)
committerSteve Myers <steve@notmandatory.org>
Thu, 6 Mar 2025 14:53:19 +0000 (08:53 -0600)
CONTRIBUTING.md

index 9c1dc6ff7a8108f85bc63661161c114989523f00..6c89388881144b1b23ac951e97f086b9db4350c6 100644 (file)
@@ -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
 -------------