Skip to content
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

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
86 commits
Select commit Hold shift + click to select a range
af0ebdd
docs: add explainer page about Dev Card feature
CBID2 Sep 2, 2023
98f6a72
docs: add explainer page about the dev card
CBID2 Sep 3, 2023
4dc016e
Revert "docs: add explainer page about the dev card"
CBID2 Sep 3, 2023
f8bbc83
Install the CodeSee workflow. Learn more at https://docs.codesee.io
Sep 4, 2023
9c0de8b
Merge branch 'open-sauced:main' into main
CBID2 Sep 19, 2023
d929e6a
Merge branch 'open-sauced:main' into main
CBID2 Sep 28, 2023
5f2296c
Merge branch 'open-sauced:main' into main
CBID2 Oct 9, 2023
cd66e09
Merge branch 'open-sauced:main' into main
CBID2 Oct 10, 2023
87f6e8d
Merge branch 'open-sauced:main' into main
CBID2 Oct 12, 2023
bbf41c9
Merge branch 'open-sauced:main' into main
CBID2 Oct 14, 2023
da6e625
Merge branch 'open-sauced:main' into main
CBID2 Oct 20, 2023
fad2387
Merge branch 'open-sauced:main' into main
CBID2 Dec 7, 2023
a0f30ce
Merge branch 'open-sauced:main' into main
CBID2 Dec 15, 2023
411bff9
Merge branch 'open-sauced:main' into main
CBID2 Jan 29, 2024
0deff77
Merge branch 'open-sauced:main' into main
CBID2 Feb 11, 2024
5c53a04
Merge branch 'open-sauced:main' into main
CBID2 Mar 16, 2024
36488c5
Merge branch 'open-sauced:main' into main
CBID2 Apr 3, 2024
1f148ef
feat: adding section on growing your project
CBID2 Apr 3, 2024
a3f16f9
Revert "Install the CodeSee workflow. Learn more at https://docs.code…
CBID2 Apr 3, 2024
578aa7b
eat: add explanation in "when to grow your project section
CBID2 Apr 3, 2024
012eebb
fix: fix markdown error
CBID2 Apr 3, 2024
4012029
docs: finish section on identifying and recruiting team members and n…
CBID2 Apr 5, 2024
0bbf75c
docs: finish section on monitor team participation
CBID2 Apr 5, 2024
6470404
docs: revise section on recruiting contributors
CBID2 Apr 5, 2024
8175912
docs: made some edits
CBID2 Apr 7, 2024
38b9e91
docs: replace image with gif
CBID2 Apr 7, 2024
ccd0cb7
feat: hyperlink phrases to guides
CBID2 Apr 7, 2024
5fe6061
docs: fix tip format
CBID2 Apr 7, 2024
4d00562
docs: made some changes
CBID2 Apr 7, 2024
b0a71d2
docs: revise ending sentence
CBID2 Apr 7, 2024
a34d4c4
docs: made changes to third section
CBID2 Apr 10, 2024
3d8b32a
docs: remove tip
CBID2 Apr 10, 2024
e4f14ee
docs: revise last section
CBID2 Apr 10, 2024
521f3ea
docs: revise sentence
CBID2 Apr 10, 2024
18fde85
docs: fix hyperlinks
CBID2 Apr 10, 2024
1473e27
docs: add more keywords
CBID2 Apr 11, 2024
9e3725b
fix: change vocab
CBID2 Apr 11, 2024
e736399
Update growing-your-project.md
CBID2 Apr 11, 2024
4cbc58e
docs: fix grammar error
CBID2 Apr 11, 2024
3bb5f59
fix: revise grammar
CBID2 Apr 11, 2024
fcb1137
docs: fix capitalization error
CBID2 Apr 11, 2024
eec89e2
docs: add space at the bottom
CBID2 Apr 11, 2024
17f13a1
docs: fix more grammar erry
CBID2 Apr 11, 2024
cb4d91d
docs: add space after bullet point
CBID2 Apr 11, 2024
a793266
docs: make changes to the headings
CBID2 Apr 11, 2024
60e92d1
Update docs/maintainers/growing-your-project.md
CBID2 Apr 11, 2024
2505047
docs: fix heading format
CBID2 Apr 13, 2024
c41207c
docs: add link to repoinsights page
CBID2 Apr 13, 2024
f01196d
docs: revise sentence in recruitment section
CBID2 Apr 17, 2024
206c542
docs: revise typo
CBID2 Apr 17, 2024
24604d8
docs: omit line 12
CBID2 Apr 20, 2024
56f112b
docs: improve sentence
CBID2 Apr 20, 2024
905ddde
docs: add hyperlink
CBID2 Apr 20, 2024
7c205f9
docs: made a few updates
CBID2 Apr 20, 2024
00f3975
docs: change to simple sentence
CBID2 Apr 20, 2024
edfb8b5
docs: replace the sentence
CBID2 Apr 20, 2024
e080148
docs: add a note about creating a team on GitHub
CBID2 Apr 20, 2024
3750ba3
docs: revise the paragraph in the first section
CBID2 Apr 20, 2024
bdc430b
docs: add another section
CBID2 Apr 20, 2024
2531e47
docs: revise section on team participation
CBID2 Apr 20, 2024
fbdbbe1
docs: add section on transparency
CBID2 Apr 21, 2024
ddbab50
docs: made some revisions
CBID2 Apr 21, 2024
513e053
docs: add Additional Resources section
CBID2 Apr 21, 2024
53f1a30
docs: fix markdown formatting errors
CBID2 Apr 21, 2024
ef71307
docs: revise sentence
CBID2 Apr 21, 2024
2e22e0a
docs: revise sentence
CBID2 Apr 21, 2024
9aecda0
docs: made the paragraph in the section on transparency smoother
CBID2 Apr 21, 2024
60f8a38
docs: revise sentence
CBID2 Apr 21, 2024
8b728a8
Merge branch 'open-sauced:main' into adding-growing-your-project-section
CBID2 Apr 24, 2024
7aa45e2
docs: change formatting
CBID2 Apr 25, 2024
d9e1901
docs: change wording
CBID2 Apr 25, 2024
67452a0
docs: change formatting
CBID2 Apr 25, 2024
32aad75
docs: change wording
CBID2 Apr 25, 2024
9046e03
docs: change formatting
CBID2 Apr 25, 2024
8641596
docs: improving sentence
CBID2 Apr 25, 2024
934355b
docs: hyperlinks information
CBID2 Apr 25, 2024
5054f51
docs: change word
CBID2 Apr 25, 2024
274e7f2
docs: revise first bullet point in section about communicating with t…
CBID2 Apr 27, 2024
0f212e2
docs: fix markdown errors
CBID2 Apr 27, 2024
8edcecf
Merge branch 'open-sauced:main' into adding-growing-your-project-section
CBID2 May 27, 2024
6875a4e
docs: added a note about the new StarSearch feature
CBID2 May 27, 2024
165c670
docs: fixed formatting of the note
CBID2 May 27, 2024
e0ca126
docs: fix formatting
CBID2 May 27, 2024
f18937b
Merge branch 'open-sauced:main' into adding-growing-your-project-section
CBID2 May 27, 2024
7c94f14
docs: redid the note
CBID2 May 27, 2024
d68ea04
Merge branch 'open-sauced:main' into adding-growing-your-project-section
CBID2 Jun 3, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions docs/maintainers/growing-your-project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
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?

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

CBID2 marked this conversation as resolved.
Show resolved Hide resolved
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.
:::note

BekahHW marked this conversation as resolved.
Show resolved Hide resolved
If you need more assistance with finding new contributors and team members for your project, consider using our AI-powered chatbot, [StarSearch](../features/star-search.md#user-guide).

:::

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)".

## Recruiting Team Members and Contributors Outside of Your Project

BekahHW marked this conversation as resolved.
Show resolved Hide resolved
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.

:::tip

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 dashboard](../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:

- 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 card to see if it aligns with the number in the Repositories card.
- Check your project's [Activity](../welcome/glossary.md#activity) ratio in your project's statistic card to determine how often they contribute to it.

:::tip

If your project's Activity ratio presents as "Low", 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:

- Analyze the number of open and merged pull requests, as well as open and closed issues in your project's statistic card to think of new ways to improve the speed of reviewing and merging contributions. Also, consider reviewing your project's [PR velocity](../welcome/glossary.md#pr-velocity) to identify more ways to optimize your process of reviewing and merging pull requests.
- Use the amount of stars and forks displayed in the Engagement card to discuss the effectiveness of current promotion strategies and to determine new methods to promote the project.

## 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)
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ module.exports = {
"maintainers/maintainers-guide-to-open-sauced",
"maintainers/understanding-repo-insights",
"maintainers/understanding-contribs-insights",
"maintainers/growing-your-project",
],
},
{
Expand Down
Loading