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

Conversation

CBID2
Copy link
Contributor

@CBID2 CBID2 commented Apr 3, 2024

Description

This PR adds a section to the Maintainers Guide on growing open source projects. It will give maintainers an idea on how OpenSauced can help them with this process.

What I have done so far

  • Add growing-your-project.md to docs > maintainers

  • In sidebar.js, add `maintainers/growing-your-project' path below the guide: "maintainers/maintainers-guide-to-open-sauced",

  • In growing-your-project.md, create the following sections:

    • When to grow your project (brief explanation of need to get more contributors or add people to teams (maintainers, triage, docs)

    • How to identify new contributors and team members

      • Look at existing contributors. How is there participation? Are they engaged? Are they invested in the success of the project?
      • Create an insight page with your projects. Add the most active contributors to a list.
    • Recruiting team members and contributors

      • Create an insight page with projects similar to yours. Add contributors you think might be a good fit to a list. After spending some time monitoring, reach out to them.
    • Understanding Team Participation.

      • It's important to monitor team participation. Once you have someone on a team, add them to your list to monitor your participation. (Use the team sync feature -- link to the gif). It's useful to set a timeframe for how active they need to be.

Related Tickets & Documents

Closes #235

Mobile & Desktop Screenshots/Recordings

Steps to QA

Tier (staff will fill in)

  • Tier 1
  • Tier 2
  • Tier 3
  • Tier 4

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Copy link

netlify bot commented Apr 3, 2024

👷 Deploy request for docs-open pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 7c94f14

@CBID2 CBID2 changed the title Adding growing your project section docs: add growing your project section Apr 3, 2024
@CBID2 CBID2 self-assigned this Apr 3, 2024
@CBID2 CBID2 added the 💡 feature A label to note if work is a feature label Apr 3, 2024
@CBID2 CBID2 marked this pull request as ready for review April 5, 2024 01:09
@CBID2 CBID2 requested a review from a team as a code owner April 5, 2024 01:09
@BekahHW
Copy link
Member

BekahHW commented Apr 26, 2024

@CBID2 when you feel like things are ready, please mark the PR as "Ready for Review"

@CBID2 CBID2 marked this pull request as ready for review April 27, 2024 01:54
@CBID2
Copy link
Contributor Author

CBID2 commented Apr 27, 2024

@CBID2 when you feel like things are ready, please mark the PR as "Ready for Review"

I'm ready now @BekahHW.

@CBID2
Copy link
Contributor Author

CBID2 commented May 9, 2024

Hey @BekahHW and @adiati98. I made a small update to the guide since the StarSearch feature has been released. Check them out when you can.

@adiati98
Copy link
Member

@CBID2,
Have you run and test this locally?
Because when I run this locally, I see this:

Screenshot 2024-05-27 164933

@CBID2
Copy link
Contributor Author

CBID2 commented May 27, 2024

@CBID2, Have you run and test this locally? Because when I run this locally, I see this:

Screenshot 2024-05-27 164933

Hey @adiati98. I made the change and ran it locally. Here's how it looks
screenshot of note

@BekahHW
Copy link
Member

BekahHW commented May 28, 2024

Hey @CBID2,

We noticed that you have some unverified commits in your PR.

Can you look into what's going on with this? Here's the GH docs on verification.

image

@CBID2
Copy link
Contributor Author

CBID2 commented May 29, 2024

Hey @CBID2,

We noticed that you have some unverified commits in your PR.

Can you look into what's going on with this? Here's the GH docs on verification.
image

Hey @BekahHW. I have been switching between using VS.Code's Source Control and the terminal to push my commits.

@BekahHW
Copy link
Member

BekahHW commented Jun 3, 2024

Hey @CBID2,
We noticed that you have some unverified commits in your PR.
Can you look into what's going on with this? Here's the GH docs on verification.
image

Hey @BekahHW. I have been switching between using VS.Code's Source Control and the terminal to push my commits.

Looks like you might need to set it up in one of them.

@BekahHW BekahHW marked this pull request as draft June 3, 2024 15:33
@BekahHW
Copy link
Member

BekahHW commented Jun 3, 2024

Hey @CBID2, I converted this to a draft until you have some time to go through the comments and create a revision strategy.

Copy link

netlify bot commented Jun 3, 2024

Deploy Preview for saucedocs ready!

Name Link
🔨 Latest commit d68ea04
🔍 Latest deploy log https://app.netlify.com/sites/saucedocs/deploys/665de688c5f3a400084296e7
😎 Deploy Preview https://deploy-preview-291--saucedocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@CBID2
Copy link
Contributor Author

CBID2 commented Jun 4, 2024

Hey @CBID2, I converted this to a draft until you have some time to go through the comments and create a revision strategy.

Hi @BekahHW. I created a new PR for this issue. It's #324

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 feature A label to note if work is a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: Add section on Growing Your Project to the Maintainers Section
3 participants