docs: add a guide for maintainers on how to growing their open source projects #324
Conversation
This reverts commit 98f6a72.
✅ Deploy Preview for saucedocs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Hi @BekahHW. I just reread my entry for this PR, and I'm ready for a review. |
|
how can i contribute to this? |
| @@ -178,6 +207,5 @@ module.exports = { | |||
| "opensauced-packages/semantic-release", | |||
| ], | |||
| }, | |||
|
|
|||
There was a problem hiding this comment.
community guidlines and procedures
There was a problem hiding this comment.
@BekahHW, what do you think of this suggestion?
|
Hey @BekahHW! :) Can you review this please? |
There was a problem hiding this comment.
Make sure you go through all the original comments. I've given previous feedback and I still don't see it being addressed in this guide.
Also, I suggest going through this as an instructional guide and following your instructions. Is it the best path? Is it the most discoverable for users? Sometimes it can be useful to record yourself doing different paths to see which had the least friction.
|
|
||
| ## 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. |
There was a problem hiding this comment.
I'm not sure why someone would want to start with a repository insight page. Is this for their project? For other projects?
The flow at OpenSauced starts with the workspace. Another option would be to look at a repo page.
|
|
||
| > 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. |
There was a problem hiding this comment.
We should probably talk about what it means to grow. Do they want someone to help with coding, writing issues, or reviewing and approving PRs, determining the direction of the project, etc.
There was a problem hiding this comment.
I'm still not seeing this addressed. Usually when a project makes a deliberate decision to grow, it's because the maintainer can't handle things on their own, there's more to do bc there are more users/contributors, they want to add a new feature, but know they can't do that on their own, etc.
| @@ -35,6 +35,24 @@ module.exports = { | |||
| { | |||
| type: "category", | |||
| label: "Guides to OpenSauced", | |||
| collapsed: false, | |||
There was a problem hiding this comment.
I'm not sure why this is being added here.
|
|
||
| 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) |
There was a problem hiding this comment.
Let's use the original post: https://opensauced.pizza/blog/scaling-oss-projects
| 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 | ||
|
|
There was a problem hiding this comment.
The OSCR isn't on the Repo Insights page, so I'm not sure why it's being mentioned here.
|
|
||
| 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. |
There was a problem hiding this comment.
agreement issue: After the people have
Description
This PR adds a new guide in the maintainers section of OpenSauced's documentation site. It'll give them ideas on how to use OpenSauced's various features to grow their open source project.
Related Tickets & Documents
Closes #235
Relates to #291
Mobile & Desktop Screenshots/Recordings
Steps to QA
Tier (staff will fill in)
[optional] What gif best describes this PR or how it makes you feel?