From af0ebdd8493749c594a8ba41091e25acd7e59875 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Sat, 2 Sep 2023 16:46:34 -0400 Subject: [PATCH 1/8] docs: add explainer page about Dev Card feature --- docs/community/dev-card.md | 0 sidebars.js | 1 + 2 files changed, 1 insertion(+) create mode 100644 docs/community/dev-card.md diff --git a/docs/community/dev-card.md b/docs/community/dev-card.md new file mode 100644 index 00000000..e69de29b diff --git a/sidebars.js b/sidebars.js index 97946ec6..ec09f9b3 100644 --- a/sidebars.js +++ b/sidebars.js @@ -22,6 +22,7 @@ module.exports = { "community/highlights", "community/insights", "community/faqs", + "community/dev-card", ], }, { From 98f6a7283456c654291fd5fe5bfc766cd7e0183f Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Sun, 3 Sep 2023 00:33:50 -0400 Subject: [PATCH 2/8] docs: add explainer page about the dev card --- docs/community/dev-card.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/community/dev-card.md b/docs/community/dev-card.md index e69de29b..fb5dd05a 100644 --- a/docs/community/dev-card.md +++ b/docs/community/dev-card.md @@ -0,0 +1,9 @@ +--- +id: dev-card +title: 'Showcase your open source stats with your dev card' +sidebar_label: 'Dev Card' +keywords: +- dev-card +--- + +The Dev card feature is what we like to call your "open source business card". It displays the amount of pull requests you create, repositories you contribute to, and how often you are active in the community. Whether you are a person who's just beginning their open source journey or a maintainer looking for more contributors and/or sponsors, the dev card is a great way to show your audience how active you are in the community. From 4dc016e1486f2c1fa1d0c27f3f25b24a23900e08 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Sun, 3 Sep 2023 01:00:42 -0400 Subject: [PATCH 3/8] Revert "docs: add explainer page about the dev card" This reverts commit 98f6a7283456c654291fd5fe5bfc766cd7e0183f. --- docs/community/dev-card.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/docs/community/dev-card.md b/docs/community/dev-card.md index fb5dd05a..e69de29b 100644 --- a/docs/community/dev-card.md +++ b/docs/community/dev-card.md @@ -1,9 +0,0 @@ ---- -id: dev-card -title: 'Showcase your open source stats with your dev card' -sidebar_label: 'Dev Card' -keywords: -- dev-card ---- - -The Dev card feature is what we like to call your "open source business card". It displays the amount of pull requests you create, repositories you contribute to, and how often you are active in the community. Whether you are a person who's just beginning their open source journey or a maintainer looking for more contributors and/or sponsors, the dev card is a great way to show your audience how active you are in the community. From f8bbc837133fa588434571053b389e48859c9c9f Mon Sep 17 00:00:00 2001 From: "codesee-maps[bot]" <86324825+codesee-maps[bot]@users.noreply.github.com> Date: Mon, 4 Sep 2023 15:21:33 +0000 Subject: [PATCH 4/8] Install the CodeSee workflow. Learn more at https://docs.codesee.io --- .github/workflows/codesee-arch-diagram.yml | 23 ++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/workflows/codesee-arch-diagram.yml diff --git a/.github/workflows/codesee-arch-diagram.yml b/.github/workflows/codesee-arch-diagram.yml new file mode 100644 index 00000000..806d41d1 --- /dev/null +++ b/.github/workflows/codesee-arch-diagram.yml @@ -0,0 +1,23 @@ +# This workflow was added by CodeSee. Learn more at https://codesee.io/ +# This is v2.0 of this workflow file +on: + push: + branches: + - main + pull_request_target: + types: [opened, synchronize, reopened] + +name: CodeSee + +permissions: read-all + +jobs: + codesee: + runs-on: ubuntu-latest + continue-on-error: true + name: Analyze the repo with CodeSee + steps: + - uses: Codesee-io/codesee-action@v2 + with: + codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }} + codesee-url: https://app.codesee.io From 327f6801c0218fb2506acaaa7733249ca982ce88 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Tue, 4 Jun 2024 15:31:44 -0400 Subject: [PATCH 5/8] docs: adding a section about growing an open source project (take 2) --- docs/maintainers/growing-your-project.md | 81 ++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 docs/maintainers/growing-your-project.md diff --git a/docs/maintainers/growing-your-project.md b/docs/maintainers/growing-your-project.md new file mode 100644 index 00000000..5cb8e848 --- /dev/null +++ b/docs/maintainers/growing-your-project.md @@ -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. + +## 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. +:::note + +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 + +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. + +![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) From d2141b05f9623244d54aa6733164ece3901ef201 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Tue, 4 Jun 2024 15:33:43 -0400 Subject: [PATCH 6/8] docs: adding section to the sidebars --- sidebars.js | 51 +++++++++++++++++++++++++++------------------------ 1 file changed, 27 insertions(+), 24 deletions(-) diff --git a/sidebars.js b/sidebars.js index aeb0b0f5..026f2558 100644 --- a/sidebars.js +++ b/sidebars.js @@ -36,24 +36,23 @@ module.exports = { type: "category", label: "Guides to OpenSauced", collapsed: false, - items: [{ - type: "category", - label: "Job Seekers Guide", - collapsed: true, - items: [ - "opensauced-guides/job-seekers-guide/job-seekers-guide-introduction", - "opensauced-guides/job-seekers-guide/how-to-translate-open-source-contributions-into-career-opportunities", - ], - }, - { - type: "category", - label: "Student's Guide", - collapsed: true, - items: [ - "opensauced-guides/students-guide/students-guide", - - ], - },], + items: [ + { + type: "category", + label: "Job Seekers Guide", + collapsed: true, + items: [ + "opensauced-guides/job-seekers-guide/job-seekers-guide-introduction", + "opensauced-guides/job-seekers-guide/how-to-translate-open-source-contributions-into-career-opportunities", + ], + }, + { + type: "category", + label: "Student's Guide", + collapsed: true, + items: ["opensauced-guides/students-guide/students-guide"], + }, + ], }, { type: "category", @@ -63,6 +62,7 @@ module.exports = { "maintainers/maintainers-guide-to-open-sauced", "maintainers/understanding-repo-insights", "maintainers/understanding-contribs-insights", + "maintainers/growing-your-project", ], }, { @@ -75,11 +75,15 @@ module.exports = { type: "category", label: "Community", collapsed: false, - items: ["community/welcome-to-the-community", "community/100-days-of-oss", { - type: 'link', - label: 'Open Source Education Path', - href: 'https://intro.opensauced.pizza/#/', - },], + items: [ + "community/welcome-to-the-community", + "community/100-days-of-oss", + { + type: "link", + label: "Open Source Education Path", + href: "https://intro.opensauced.pizza/#/", + }, + ], }, { type: "category", @@ -170,6 +174,5 @@ module.exports = { "opensauced-packages/semantic-release", ], }, - ], }; From 255f1e34dc840a7b567513195bac11924defbc18 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Tue, 4 Jun 2024 16:33:37 -0400 Subject: [PATCH 7/8] fix: omit unwanted workflow --- .github/workflows/codesee-arch-diagram.yml | 23 ---------------------- 1 file changed, 23 deletions(-) delete mode 100644 .github/workflows/codesee-arch-diagram.yml diff --git a/.github/workflows/codesee-arch-diagram.yml b/.github/workflows/codesee-arch-diagram.yml deleted file mode 100644 index 806d41d1..00000000 --- a/.github/workflows/codesee-arch-diagram.yml +++ /dev/null @@ -1,23 +0,0 @@ -# This workflow was added by CodeSee. Learn more at https://codesee.io/ -# This is v2.0 of this workflow file -on: - push: - branches: - - main - pull_request_target: - types: [opened, synchronize, reopened] - -name: CodeSee - -permissions: read-all - -jobs: - codesee: - runs-on: ubuntu-latest - continue-on-error: true - name: Analyze the repo with CodeSee - steps: - - uses: Codesee-io/codesee-action@v2 - with: - codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }} - codesee-url: https://app.codesee.io From 653373d439b1de0bc8fcf2dbad1e9455a96c3d0d Mon Sep 17 00:00:00 2001 From: Christine Date: Sun, 11 Aug 2024 20:07:44 +0000 Subject: [PATCH 8/8] feat: add info about OSCR scores Signed-off-by: Christine --- docs/maintainers/growing-your-project.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/maintainers/growing-your-project.md b/docs/maintainers/growing-your-project.md index 5cb8e848..b6416e6f 100644 --- a/docs/maintainers/growing-your-project.md +++ b/docs/maintainers/growing-your-project.md @@ -42,8 +42,7 @@ If you've looked at your project's [Repository Insight Page](../features/repo-in :::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. - +Consider checking out our [Understanding Repository Insights Data](../features/repo-insights.md) guide and learn about [OSCR](../welcome/glossary.md#oscr-score) scores 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.