Skip to content

Commit b6f5fc0

Browse files
committed
add interacting w/ new contribs guide
1 parent af0fb9d commit b6f5fc0

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed

content/maintainers/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,8 @@ This is a draft document.
88

99
The scientific Python ecosystem welcomes your expertise and enthusiasm!
1010

11+
- [Interacting With New Contributors]({{< relref
12+
"/maintainers/interacting-with-new-contributors"
13+
>}})
1114
- [Project Meetings Guide]({{< relref "/maintainers/meeting_types" >}})
15+
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: "How to interact with new community
3+
members"
4+
---
5+
6+
{{< notice warning >}}
7+
This is a draft document.
8+
{{< /notice >}}
9+
10+
As a maintainer, you will be the first point of
11+
contact for new community members. It is important
12+
to embody a positive and helpful force for the
13+
health of your community.
14+
15+
### Be welcoming
16+
Always behave polite, patient, and understanding.
17+
Many contributors are acting on their own time so
18+
try to create an environment that is energizing,
19+
not draining.
20+
21+
Use language to show that you are excited and
22+
grateful about their contributions to the project.
23+
Avoid saying things that could be construed as
24+
meaning otherwise or being too short.
25+
26+
Many first-time contributors are intimidated and
27+
nervous about making mistakes, so keep in mind for
28+
both you and them that mistakes are natural and
29+
part of the learning process. Assure and empower
30+
them with your help and mentorship so that they
31+
feel supported and comfortable contributing to the
32+
project.
33+
34+
### Provide resources, not solutions
35+
While some level of shepherding is needed, be
36+
careful not to micro-manage contributors, as it
37+
hinders the learning process and can be
38+
frustrating for both parties. First offer guidance
39+
before using more hands-on approaches.
40+
41+
For tasks that may be too advanced or daunting for
42+
a first-time contributor, such as comprehensive
43+
testing, benchmarking, or doc-building, offer to
44+
handle that part or to lend your support while
45+
they try it themselves.
46+
47+
Avoid excessive nitpicking as requesting constant
48+
small changes can be discouraging to a new
49+
contributor. Instead, you can make a follow-up PR
50+
after the merge to fix these or use an opinionated
51+
formatter, such as
52+
[`black`](https://github.com/psf/black), to handle
53+
most style-related nitpicks.
54+
55+
### Recognize contributions
56+
Remember that contributions are a good thing that
57+
should be celebrated and encouraged. Communicate
58+
your appreciation for the work your community
59+
members are doing and connect the impact their
60+
contributions have to your project's goals and how
61+
it will help many others.
62+
63+
By providing a positive contributing experience,
64+
you can create a positive feedback loop where
65+
community members enjoy and want to continue their
66+
amazing contributions to your project!

0 commit comments

Comments
 (0)