-
Notifications
You must be signed in to change notification settings - Fork 65
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add growing your project section #291
Changes from 69 commits
af0ebdd
98f6a72
4dc016e
f8bbc83
9c0de8b
d929e6a
5f2296c
cd66e09
87f6e8d
bbf41c9
da6e625
fad2387
a0f30ce
411bff9
0deff77
5c53a04
36488c5
1f148ef
a3f16f9
578aa7b
012eebb
4012029
0bbf75c
6470404
8175912
38b9e91
ccd0cb7
5fe6061
4d00562
b0a71d2
a34d4c4
3d8b32a
e4f14ee
521f3ea
18fde85
1473e27
9e3725b
e736399
4cbc58e
3bb5f59
fcb1137
eec89e2
17f13a1
cb4d91d
a793266
60e92d1
2505047
c41207c
f01196d
206c542
24604d8
56f112b
905ddde
7c205f9
00f3975
edfb8b5
e080148
3750ba3
bdc430b
2531e47
fbdbbe1
ddbab50
513e053
53f1a30
ef71307
2e22e0a
9aecda0
60f8a38
8b728a8
7aa45e2
d9e1901
67452a0
32aad75
9046e03
8641596
934355b
5054f51
274e7f2
0f212e2
8edcecf
6875a4e
165c670
e0ca126
f18937b
7c94f14
d68ea04
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
--- | ||
id: growing-your-project | ||
title: "Growing Your Project" | ||
sidebar_label: "Growing Your Project" | ||
keywords: | ||
- "open source maintainers" | ||
- "maintainers guides" | ||
- "open source project success" | ||
- "growing an open source project" | ||
--- | ||
|
||
|
||
|
||
## When to grow your project | ||
|
||
When it comes to deciding on whether your open source project is ready to grow, consider asking yourself the following question: | ||
|
||
- Are there active community members who would be interested in progressing to an official role? | ||
CBID2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
If you have said yes, it's time to develop your growth strategies. If you haven't already, consider creating different teams for specific purposes. For example, you can create a docs team for documentation maintenance, a triage team for reviewing and approving issues, or a maintainer team to help you with overall project oversight. Once you have decided the types of teams you want to add to your project, it's time to start building the open source team of your dreams. | ||
|
||
BekahHW marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## How to identify new contributors and team members | ||
|
||
When it comes to planning the growth strategies for your open source project, picking the right people will determine how successful your project will be. You can discover the right people for your project by starting with a [Repository Insight Page](../maintainers/maintainers-guide.md#creating-a-new-repository-insight-page). From there, you can use the Contributors dashboard to help you get a better understanding of your existing contributors. | ||
|
||
BekahHW marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Once you have found a reliable group of contributors, consider adding them to a [Contributor Insight Page](../maintainers/maintainers-guide.md#creating-a-new-contributor-insight-page). It can help you better understand their contributions to your project and the open source ecosystem. Here are some methods you can use to help you analyze its data: | ||
|
||
- Monitor contributors to see if they are active enough in your repositories to contribute as a team member. | ||
- Identify your top contributors to extend an invitation to join a team. | ||
- Identify active contributors in other repositories who may be interested in joining your team. | ||
|
||
If you need more tips on how to pick people that can help grow your project, check out our blog post, ["How to Build Your Open Source Dream Team"](https://dev.to/opensauced/how-to-build-your-open-source-dream-team-a-guide-3i90). | ||
CBID2 marked this conversation as resolved.
Show resolved
Hide resolved
CBID2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Recruiting Team Members and Contributors Outside of Your Project | ||
|
||
If you've looked at your project's[Repository Insight Page](../features/repo-insights.md) and realize there is no one that could help you, consider recruiting new contributors. To do that, create another repository insight page with projects that are similar to yours. From there, determine which contributors suit your project, add them to a list, and monitor their progress. | ||
CBID2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
:::tip | ||
|
||
BekahHW marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Consider checking out our [Understanding Repository Insights Data](../features/repo-insights.md) guide to give you an idea on what to look for when narrowing down your list. | ||
|
||
::: | ||
|
||
Once you've identified the people you want to ask, reach out to them, providing a clear message and a list of expectations. | ||
|
||
After the people from your list has agreed to join your project, create [your team on GitHub](https://docs.github.com/en/organizations/organizing-members-into-teams/creating-a-team) and [sync it](../welcome/faqs.md#sync-your-github-team) to your project's Repository Insight page. | ||
CBID2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
![team sync gif](../../static/gif/team-sync.gif) | ||
|
||
## Understanding team participation | ||
|
||
To ensure that your open source project reaches it growth strategy goal(s), it is important that your team members actively participate in the project as much as possible. The [Contributors tab](../maintainers/maintainers-guide.md#contributors) in your project's Repository Insights page can be helpful in fostering participation. Here are some strategies you can use this tab to monitor your team member's progress: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
CBID2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Identify the amount of repositories they contributed to in the Repositories section to see if they are immersed in the project. | ||
- Take note of the date of their recent contribution in the Last Contributed section to see if it aligns with the number in the Repositories section. | ||
- Check the level in the Act tab to determine how often they contribute to the project | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
:::tip | ||
|
||
If you see "Low" in the Act tab, consider messaging your team member about this information and request a meeting to discuss possible strategies to help them progress. | ||
|
||
::: | ||
|
||
## Creating Transparency and Communication With Your Team | ||
|
||
The methods utilized to collaborate and communicate with your team play a crucial role in the growth of your open source project. Creating and sharing your project's [workspace](../features/workspaces.md) page with your team members can be helpful in fostering a collaborative environment. After creating this page, here are some ways to leverage its information to engage with your team: | ||
CBID2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Analyze the closed number Pull Requests and Issues tabs and the PR velocity to think of new ways to quickly review and merge people's contributions. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't quite understand what do you mean here. Can you help me to understand it better? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was referring to the dashboard in the Workspace page(refer to the section in the that says "pull requests" in the screenshot below). I'm thinking maintainers could use it as metric to determine if they are reviewing contributions effectively. Does that make more sense now @adiati98? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, I see. You're looking at those. However, you might want to formulate the wording better. I'm not sure about native-English speakers, but I certainly don't understand this at all. 😅 |
||
- Use the amount of stars and forks displayed in the Engagement tab to discuss the effectiveness of current promotion strategies and to determine new methods to promote the project. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is no Engagement "tab". There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes there is @adiati98 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I know there's an "Engagement", but I'm not sure if it calls a "tab". It looks more like a "card" to me. Add: I just looked it up in the app repo, and found in one of the issues, it calls "statistic card". @BekahHW what should we call this in docs? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah so that's the name! I think statistic card would be a good name. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yep. Also, it would be great if you try to search around first, then ask for clarity with some explanation of what you did and you've get so far when you're not sure about something rather than assuming. 🙂 |
||
|
||
## Additional Resources | ||
|
||
If you're looking for more resources to aid you in your open source project's growth journey, check out these posts written by the OpenSauced team: | ||
|
||
- [Scaling Open Source Projects: Navigating Challenges](https://dev.to/opensauced/navigating-the-challenges-of-scaling-open-source-projects-11h2) | ||
- [Collaborate, Conquer, & Grow: Mastering the Art of Issue Management for Open Source Projects](https://dev.to/opensauced/collaborate-conquer-grow-mastering-the-art-of-issue-management-for-open-source-projects-49gi) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You haven't capitalized some of the titles as per my requests a while ago. :)