docs: add growing your project section #291

CBID2 · 2024-04-03T21:26:44Z

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?

This reverts commit 98f6a72.

Signed-off-by: Christine <[email protected]>

netlify · 2024-04-03T21:26:47Z

👷 Deploy request for docs-open pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`0f212e2`

…see.io" This reverts commit f8bbc83.

…ew contributors Signed-off-by: Christine <[email protected]>

Signed-off-by: Christine <[email protected]>

docs/maintainers/growing-your-project.md

Signed-off-by: Christine Belzie <[email protected]>

BekahHW · 2024-04-24T15:17:40Z

@CBID2 just a heads-up we just merged in a pretty big update to the docs, so you'll want to pull from main and install the new dependencies.

CBID2 · 2024-04-24T20:40:39Z

@CBID2 just a heads-up we just merged in a pretty big update to the docs, so you'll want to pull from main and install the new dependencies.

How do I install the new dependencies @BekahHW?

adiati98 · 2024-04-25T06:53:43Z

@CBID2 just a heads-up we just merged in a pretty big update to the docs, so you'll want to pull from main and install the new dependencies.

How do I install the new dependencies @BekahHW?

Just run npm ci as mentioned on the README after you pull the changes, @CBID2.

Then, don't forget to run it locally to test if it works.

CBID2 · 2024-04-25T19:32:15Z

@CBID2 just a heads-up we just merged in a pretty big update to the docs, so you'll want to pull from main and install the new dependencies.

How do I install the new dependencies @BekahHW?

Just run npm ci as mentioned on the README after you pull the changes, @CBID2.

Then, don't forget to run it locally to test if it works.

@adiati98, I got this error when I did the commands:

rror: Unsupported engine
    at checkEngine (/home/gitpod/.npm/_npx/6cea267ee22d4a04/node_modules/npm-install-checks/index.js:15:25)
    at Object.<anonymous> (/home/gitpod/.npm/_npx/6cea267ee22d4a04/node_modules/@open-sauced/check-engines/index.js:13:1)
    at Module._compile (node:internal/modules/cjs/loader:1369:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1427:10)
    at Module.load (node:internal/modules/cjs/loader:1206:32)
    at Module._load (node:internal/modules/cjs/loader:1022:12)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:135:12)
    at node:internal/main/run_main_module:28:49 {
  pkgid: '@open-sauced/docs.opensauced.pizza',
  current: { node: '20.12.2', npm: '10.5.0' },
  required: { node: '^18', npm: '>=9' },
  code: 'EBADENGINE'
}

BekahHW · 2024-04-25T19:34:40Z

@CBID2 what have you tried to fix the error?

CBID2 · 2024-04-25T19:36:31Z

@CBID2 what have you tried to fix the error?

Kill the terminal and do the steps again @BekahHW.

adiati98 · 2024-04-25T19:39:57Z

@CBID2 have you tried to google the error message?

CBID2 · 2024-04-25T19:40:43Z

@CBID2 have you tried to google the error message?

Doing that now

BekahHW · 2024-04-25T19:45:29Z

@CBID2 have you tried to google the error message?

Doing that now

It's good practice to start by googling or asking chatGPT to help you navigate the error. Here's a Virtual Coffee Guide that might help you develop a process for navigating errors.

CBID2 · 2024-04-25T20:25:41Z

@CBID2 have you tried to google the error message?

Doing that now

It's good practice to start by googling or asking chatGPT to help you navigate the error. Here's a Virtual Coffee Guide that might help you develop a process for navigating errors.

I got it to work @BekahHW and @adiati98! :) It turns out I had to downgrade my version of Nodejs.
Should we go onto reviewing my PR now?

adiati98

Hi @CBID2,

I left some reviews here. :)

I would like to give you a suggestion to read the docs, especially those are related to what you write here.
And you might want to explore the app so you can relate what are written in the docs and how the features actually work.

Don't hesitate to ask us if you have questions!

Also, while you're waiting for Bekah's review regarding to the content, you can spend time to reread your changes and see if you can fix or improve anything.

Thank you!

adiati98 · 2024-04-25T21:51:23Z

docs/maintainers/growing-your-project.md

+
+
+
+## When to grow your project


You haven't capitalized some of the titles as per my requests a while ago. :)

docs/maintainers/growing-your-project.md

adiati98 · 2024-04-25T21:58:30Z

docs/maintainers/growing-your-project.md

+
+## 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:


We're now using the term "dashboard" instead of "tab". So, please change the term here.

Capitalize the "page" in "Repository Insights Page".

adiati98 · 2024-04-25T22:13:41Z

docs/maintainers/growing-your-project.md

+
+- 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


What is "Act"?

It needs a period at the end of the sentence.

Inconsistency. You use the term "section" in the other bullet points, and "tab" here.

docs/maintainers/growing-your-project.md

adiati98 · 2024-04-25T22:20:01Z

docs/maintainers/growing-your-project.md

+
+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 closed number Pull Requests and Issues tabs and the PR velocity to think of new ways to quickly review and merge people's contributions.


I don't quite understand what do you mean here. Can you help me to understand it better?

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?

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. 😅

adiati98 · 2024-04-25T22:21:58Z

docs/maintainers/growing-your-project.md

+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 closed number Pull Requests and Issues tabs and the PR velocity to think of new ways to quickly review and merge people's contributions.
+- 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 is no Engagement "tab".

Yes there is @adiati98

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?

Ah so that's the name! I think statistic card would be a good name.

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. 🙂

Co-authored-by: Ayu Adiati <[email protected]>

BekahHW · 2024-04-26T14:50:05Z

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

…eam members

CBID2 · 2024-04-27T01:56:06Z

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

I'm ready now @BekahHW.

CBID2 · 2024-05-09T22:47:37Z

Hey @BekahHW and @adiati98. Should I add information about the StarSearch feature? I've been tinkering around with it and found some ways it can be applicable to this guide.

CBID2 and others added 18 commits September 2, 2023 16:46

docs: add explainer page about Dev Card feature

af0ebdd

docs: add explainer page about the dev card

98f6a72

Revert "docs: add explainer page about the dev card"

4dc016e

This reverts commit 98f6a72.

Install the CodeSee workflow. Learn more at https://docs.codesee.io

f8bbc83

Merge branch 'open-sauced:main' into main

9c0de8b

Merge branch 'open-sauced:main' into main

d929e6a

Merge branch 'open-sauced:main' into main

5f2296c

Merge branch 'open-sauced:main' into main

cd66e09

Merge branch 'open-sauced:main' into main

87f6e8d

Merge branch 'open-sauced:main' into main

bbf41c9

Merge branch 'open-sauced:main' into main

da6e625

Merge branch 'open-sauced:main' into main

fad2387

Merge branch 'open-sauced:main' into main

a0f30ce

Merge branch 'open-sauced:main' into main

411bff9

Merge branch 'open-sauced:main' into main

0deff77

Merge branch 'open-sauced:main' into main

5c53a04

Merge branch 'open-sauced:main' into main

36488c5

feat: adding section on growing your project

1f148ef

Signed-off-by: Christine <[email protected]>

CBID2 changed the title ~~Adding growing your project section~~ docs: add growing your project section Apr 3, 2024

CBID2 self-assigned this Apr 3, 2024

CBID2 added the 💡 feature A label to note if work is a feature label Apr 3, 2024

CBID2 added 5 commits April 3, 2024 21:31

Revert "Install the CodeSee workflow. Learn more at https://docs.code…

a3f16f9

…see.io" This reverts commit f8bbc83.

eat: add explanation in "when to grow your project section

578aa7b

fix: fix markdown error

012eebb

docs: finish section on identifying and recruiting team members and n…

4012029

…ew contributors Signed-off-by: Christine <[email protected]>

docs: finish section on monitor team participation

0bbf75c

Signed-off-by: Christine <[email protected]>

CBID2 marked this pull request as ready for review April 5, 2024 01:09

CBID2 requested a review from a team as a code owner April 5, 2024 01:09

CBID2 commented Apr 5, 2024

View reviewed changes

docs/maintainers/growing-your-project.md Show resolved Hide resolved

CBID2 added 4 commits April 20, 2024 23:15

docs: revise sentence

ef71307

docs: revise sentence

2e22e0a

Signed-off-by: Christine Belzie <[email protected]>

docs: made the paragraph in the section on transparency smoother

9aecda0

Signed-off-by: Christine Belzie <[email protected]>

docs: revise sentence

60f8a38

Signed-off-by: Christine Belzie <[email protected]>

Merge branch 'open-sauced:main' into adding-growing-your-project-section

8b728a8

adiati98 requested changes Apr 25, 2024

View reviewed changes

CBID2 and others added 8 commits April 25, 2024 18:54

docs: change formatting

7aa45e2

Co-authored-by: Ayu Adiati <[email protected]>

docs: change wording

d9e1901

Co-authored-by: Ayu Adiati <[email protected]>

docs: change formatting

67452a0

Co-authored-by: Ayu Adiati <[email protected]>

docs: change wording

32aad75

Co-authored-by: Ayu Adiati <[email protected]>

docs: change formatting

9046e03

Co-authored-by: Ayu Adiati <[email protected]>

docs: improving sentence

8641596

docs: hyperlinks information

934355b

docs: change word

5054f51

CBID2 and others added 2 commits April 26, 2024 21:45

docs: revise first bullet point in section about communicating with t…

274e7f2

…eam members

docs: fix markdown errors

0f212e2

CBID2 marked this pull request as ready for review April 27, 2024 01:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add growing your project section #291

docs: add growing your project section #291

CBID2 commented Apr 3, 2024 •

edited

netlify bot commented Apr 3, 2024 •

edited

BekahHW commented Apr 24, 2024

CBID2 commented Apr 24, 2024

adiati98 commented Apr 25, 2024

CBID2 commented Apr 25, 2024

BekahHW commented Apr 25, 2024

CBID2 commented Apr 25, 2024

adiati98 commented Apr 25, 2024

CBID2 commented Apr 25, 2024

BekahHW commented Apr 25, 2024

CBID2 commented Apr 25, 2024 •

edited

adiati98 left a comment

adiati98 Apr 25, 2024

adiati98 Apr 25, 2024

adiati98 Apr 25, 2024

adiati98 Apr 25, 2024

CBID2 Apr 25, 2024 •

edited

adiati98 Apr 26, 2024

adiati98 Apr 25, 2024

CBID2 Apr 25, 2024

adiati98 Apr 25, 2024 •

edited

CBID2 Apr 25, 2024

adiati98 Apr 26, 2024

BekahHW commented Apr 26, 2024

CBID2 commented Apr 27, 2024

CBID2 commented May 9, 2024


		## 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:


		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 closed number Pull Requests and Issues tabs and the PR velocity to think of new ways to quickly review and merge people's contributions.

docs: add growing your project section #291

Are you sure you want to change the base?

docs: add growing your project section #291

Conversation

CBID2 commented Apr 3, 2024 • edited

Description

What I have done so far

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Steps to QA

Tier (staff will fill in)

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

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

netlify bot commented Apr 3, 2024 • edited

👷 Deploy request for docs-open pending review.

BekahHW commented Apr 24, 2024

CBID2 commented Apr 24, 2024

adiati98 commented Apr 25, 2024

CBID2 commented Apr 25, 2024

BekahHW commented Apr 25, 2024

CBID2 commented Apr 25, 2024

adiati98 commented Apr 25, 2024

CBID2 commented Apr 25, 2024

BekahHW commented Apr 25, 2024

CBID2 commented Apr 25, 2024 • edited

adiati98 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CBID2 Apr 25, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adiati98 Apr 25, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BekahHW commented Apr 26, 2024

CBID2 commented Apr 27, 2024

CBID2 commented May 9, 2024

CBID2 commented Apr 3, 2024 •

edited

netlify bot commented Apr 3, 2024 •

edited

CBID2 commented Apr 25, 2024 •

edited

CBID2 Apr 25, 2024 •

edited

adiati98 Apr 25, 2024 •

edited