Skip to content

Commit 3dfe367

Browse files
Merge branch 'main' into fix-builds
Signed-off-by: Bryan Behrenshausen <bryan.behrenshausen@sas.com>
2 parents b2a9b8b + 5f0078a commit 3dfe367

51 files changed

Lines changed: 17306 additions & 112 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

attracting-users/building-diverse-open-source-communities-by-making-them-includive-first.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,9 @@ Rather than keeping Redis's prior BDFL style, Gottlieb and Agra built a new, lig
144144

145145
Regardless of your own project's governance model, you must include a way to train key contributors to assume leadership roles. This achieves three key goals:
146146

147-
1. Helping new contributors learn how they can grow
148-
2. Rewarding contributors who own key aspects of the project
149-
3. Preventing maintainer burnout
147+
1. Helping new contributors learn how they can grow
148+
2. Rewarding contributors who own key aspects of the project
149+
3. Preventing maintainer burnout
150150

151151
This last point is noteworthy: Sanfilippo said when he stepped down from Redis that despite his passion for coding, he never aspired to maintain a project. Without new leaders to step up—and documentation sharing how contributors can assume such roles—maintainers risk either working on projects when they no longer want to or having the project stall. Likewise, the project risks missing an opportunity to give interested contributors a chance to step up.
152152

attracting-users/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Attracting Users
2+
3+
```{toctree}
4+
:maxdepth: 1
5+
6+
README
7+
communication-norms-in-open-source-software-projects
8+
building-diverse-open-source-communities-by-making-them-includive-first
9+
```
10+

getting-started/building-a-strategy.md

Lines changed: 37 additions & 37 deletions
Large diffs are not rendered by default.

getting-started/essentials-of-building-a-community.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,9 @@ Hopefully, your investments in an open source software community will lead that
174174

175175
Some of these key metrics might include:
176176

177-
- The number of bugs fixed and the number of changes accepted over a specific time period (it's not bad for a project to have a lot of bug reports. every project has bugs, so a steady stream of bug reports shows that people are using the product—but the bugs should get fixed!)
178-
- Numbers of project downloads (many people download a product to try it out and then discard it, so use other measures if possible to gauge the real growth of the user base—for instance, the number of people participating on forums and the number of questions asked)
179-
- Your community's mix of contributor experience (have the right mix of project members, some who have been on the project for a long time and can provide institutional memory, along with more recent recruits who provide new energy)
177+
* The number of bugs fixed and the number of changes accepted over a specific time period (it's not bad for a project to have a lot of bug reports. every project has bugs, so a steady stream of bug reports shows that people are using the product—but the bugs should get fixed!)
178+
* Numbers of project downloads (many people download a product to try it out and then discard it, so use other measures if possible to gauge the real growth of the user base—for instance, the number of people participating on forums and the number of questions asked)
179+
* Your community's mix of contributor experience (have the right mix of project members, some who have been on the project for a long time and can provide institutional memory, along with more recent recruits who provide new energy)
180180

181181
## Conclusion
182182
This chapter offered an overview of essential considerations one should make when determining whether to start an open source software community and deciding how best to architect that community.

getting-started/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Getting Started
2+
3+
```{toctree}
4+
:maxdepth: 1
5+
6+
README
7+
community-101
8+
essentials-of-building-a-community
9+
building-a-strategy
10+
new-project-checklist
11+
```
12+

growing-contributors/community-manager-self-care.md

Lines changed: 28 additions & 28 deletions
Large diffs are not rendered by default.

growing-contributors/constructing-an-onboarding-experience.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -77,23 +77,23 @@ Your project will have any number of contributor pathways specific to it, but th
7777

7878
*Community-focused* pathways are opportunities for contribution that may not require specialized technical knowledge on the part of participants. These are pathways focused on helping new contributors document the project, raise awareness of and market the project, plan community meetings and events, etc.—all extraordinarily important aspects of a project's eventual success. Examples include:
7979

80-
1. Documenting workflow and governance processes
81-
2. Onboarding and mentoring new members
82-
3. Localizing content into various languages
83-
4. Copywriting (for website, newsletters, blogs)
84-
5. Managing social media
85-
6. Organizing events
80+
1. Documenting workflow and governance processes
81+
2. Onboarding and mentoring new members
82+
3. Localizing content into various languages
83+
4. Copywriting (for website, newsletters, blogs)
84+
5. Managing social media
85+
6. Organizing events
8686

8787
*Technically focused* contributor pathways, on the other hand, are contributions requiring specialized knowledge of software development (often in a particular computing language). These pathways are focused on enchancing or refining the body of software a community maintains. Examples include:
8888

89-
1. Adding new features and documentation
90-
2. Fixing existing bugs and triaging issues
91-
3. Refactoring existing work to improve it
92-
4. Performing quality assurance
93-
5. Improving user interface and user experience
94-
6. Release engineering
95-
7. Creating and maintaining project roadmap
96-
8. Code and user interface localization
89+
1. Adding new features and documentation
90+
2. Fixing existing bugs and triaging issues
91+
3. Refactoring existing work to improve it
92+
4. Performing quality assurance
93+
5. Improving user interface and user experience
94+
6. Release engineering
95+
7. Creating and maintaining project roadmap
96+
8. Code and user interface localization
9797

9898
When assessing your project's contributor pathways, ask yourself: Does your project currently offer new (and existing) contributors opportunities to contribute rewardingly to (or even take ownership of) work in each of these areas? If not, one general way to begin expanding your project is by making concerted efforts to formalize, refine, document, and advertise these contributor pathways.
9999

growing-contributors/creating-a-culture-of-mentorship.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,11 @@ If this matches your projects's version of sustainable, then a mentoring program
8989

9090
Self-sustainability is an important focus for a mentoring program. And don't think anyone goes from "mentoring people" to "a mentoring program" by accident. Here's the argument:
9191

92-
1. If we can agree that lowering the barriers for entry into a project is key to bringing in new people; and
93-
2. If we can agree that people coming into a new project benefit from having one or more people they feel permitted and even encouraged to ask questions and learn from; and
94-
3. If we can agree new people having lackluster or negative interactions with existing project members is likely to drive the new people away; and
95-
4. If we can agree that having a person (mentor, friend) for new people to turn to is a way to prevent the driving-away and especially prevent *silent segfaults* (people just disappearing with no explanation);
96-
5. Then we can see that doing mentoring with even a tiny bit of repeatable process support is going to yield better, more satisfying results than an ad-hoc process.
92+
1. If we can agree that lowering the barriers for entry into a project is key to bringing in new people; and
93+
2. If we can agree that people coming into a new project benefit from having one or more people they feel permitted and even encouraged to ask questions and learn from; and
94+
3. If we can agree new people having lackluster or negative interactions with existing project members is likely to drive the new people away; and
95+
4. If we can agree that having a person (mentor, friend) for new people to turn to is a way to prevent the driving-away and especially prevent *silent segfaults* (people just disappearing with no explanation);
96+
5. Then we can see that doing mentoring with even a tiny bit of repeatable process support is going to yield better, more satisfying results than an ad-hoc process.
9797

9898
Once you agree that even a lightweight program is better than an ad-hoc process, we're going in the right direction. With this in mind, here are a few absolute must-have elements to include in your mentoring program.
9999

growing-contributors/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Growing Contributors
2+
3+
```{toctree}
4+
:maxdepth: 1
5+
6+
README
7+
from-users-to-contributors
8+
what-is-a-contribution
9+
constructing-an-onboarding-experience
10+
creating-a-culture-of-mentorship
11+
project-and-community-governance
12+
understanding-community-roles
13+
community-manager-self-care
14+
```
15+

growing-contributors/understanding-community-roles.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ If no one is working on a document, and the community or project leaders support
3636

3737
At this point, make a formal announcement, such as by creating an issue. A due date is recommended, to provide some pressure to finish the document. Remember that a document needs to be reviewed, which could add several weeks to the project. It is also useful to create milestones, which could include:
3838

39-
1. Start writing
40-
2. Circulate first draft
41-
3. End of review period for first draft
42-
4. Circulate final draft
43-
5. End of review period for final draft
44-
6. Submitted for approval
45-
7. Approved and published
39+
1. Start writing
40+
2. Circulate first draft
41+
3. End of review period for first draft
42+
4. Circulate final draft
43+
5. End of review period for final draft
44+
6. Submitted for approval
45+
7. Approved and published
4646

4747
To be accepted into a project, the leadership or advisor group responsible for the project must approve it. These leaders should be liberal in approving documentation projects, because any new document that is relevant to a project will usually prove useful to at least some members.
4848

0 commit comments

Comments
 (0)