docs: how OSCR is calculated and how to improve it (#403)

* docs: add how OSCR is calculated section to welcome section * chore: add sidebar entry for OSCR * docs: how to improve OSCR guide draft 1 * fix: use proper tense and improve flow * enhancement: replace lists with h4s, tighten copy * fix: spacings and indentations following markdown rules * fix: change repos to repositories for consistency * fix: capitalization and punctuation * fix: maintain pull requests and PRs consistency --------- Co-authored-by: Ayu Adiati <[email protected]>
open-sauced · Oct 9, 2024 · 89738ae · 89738ae
1 parent cbdda09
commit 89738ae
Show file tree

Hide file tree

Showing 4 changed files with 159 additions and 35 deletions.
diff --git a/.gitignore b/.gitignore
@@ -15,6 +15,7 @@
 .env.development.local
 .env.test.local
 .env.production.local
+.prettierignore
 
 npm-debug.log*
 yarn-debug.log*

diff --git a/docs/opensauced-guides/oscr-score-guide/oscr-introduction.md b/docs/opensauced-guides/oscr-score-guide/oscr-introduction.md
@@ -0,0 +1,119 @@
+---
+id: oscr-guide
+title: "Guide to Improving Your OSCR"
+sidebar_label: How to Improve Your OSCR Score
+keywords:
+  - "contributors"
+  - "guides"
+  - "how to contribute to open source"
+  - "OSCR score"
+  - "Make an impact in open source"
+  - "Open Source Contributor Rating"
+  - "Open Source Score"
+---
+
+Open Source Contributor Rating ([OSCR](../../welcome/glossary.md#oscr)) is a metric that measures participation in open source projects. It is a holistic metric that considers the quality of contributions across many areas over a 90-day period. It is scored out of 300.
+
+The OSCR is one way to measure your impact in open source and can act as a positive signal of your value. However, you may want to improve your score. This guide will help you understand how to do so.
+
+## How to Improve Your OSCR Score
+
+OSCR score is calculated based on several factors that can be broadly categorized into the following:
+
+1. [Repository Engagement](#repository-engagement)
+2. [Issues & Discussions](#issues--discussions)
+3. [Pull Requests (PRs)](#pull-requests-prs)
+4. [Consistency & Quality](#consistency--quality)
+5. [Being a Good Open Source Citizen](#being-a-good-open-source-citizen)
+
+Improving in these areas will help you improve your OSCR score over time.
+
+### Repository Engagement
+
+This considers how you engage with repositories, including repository forks, stars, and commits. You can improve your score in this area by:
+
+#### Starring repositories you genuinely intend to contribute to
+
+While starring repositories is a great way to show your interest and support for a project, taking time and contributing to your starred repositories is even better. And it's a great way to boost your OSCR score.
+
+#### Forking repositories with the intention to contribute
+
+Forking repositories of projects you like is an amazing first step towards contributing to them. Going a step further and contributing to your forked repositories will help you improve your OSCR score.
+
+### Issues & Discussions
+
+This takes into account how you interact with open source repositories through issues and discussions. You can improve your score in this area by:
+
+#### Opening meaningful issues
+
+Opening issues is a good way to ease into making contributions and is very helpful to the project. You can improve your OSCR score by making sure the issues you open are:
+
+- meaningful,
+- explain the problem clearly,
+- follow the issue template, if provided.
+
+#### Engaging in discussions
+
+Leaving helpful comments on issues and Pull Requests (PRs) through clarifying issues raised or attempting to reproduce reported issues is helpful to the project and is a good way to improve your OSCR score.
+
+#### Reacting to issues and comments
+
+Reacting to issues and comments is a fun way to engage with the community around an open source project and can be a way to upvote issues you'd like prioritized.
+
+### Pull Requests (PRs)
+
+This takes into account the quality of any PRs you make and how they are received. You can improve your score in this area by:
+
+#### Opening and merging PRs
+
+Opening PRs is great for your score, but merging your PRs significantly boosts your OSCR score. A few ways you can increase the chances of your PRs being merged are:
+
+- Tying your PRs to existing issues or creating issues for them first.
+- Following the project's contribution guidelines.
+- Making small commits and keeping your PRs small.
+
+#### Creating quality PRs regularly
+
+Opening PRs on the regular is great for your score but getting your PRs closed instead of merged can quickly hurt your score. You can reduce the chances of your PRs being closed by avoiding unsolicited PRs and following the above tips for opening PRs.
+
+#### Providing thoughtful reviews on PRs
+
+Reviewing other contributors' PRs is a great way to help the project's maintainers and contribute towards your score. Keeping your reviews respectful and giving feedback in a kind manner all improve your OSCR score.
+
+#### Collaborating effectively
+
+Participating in constructive discussions respectfully and in a meaningful way improves your OSCR score.
+
+### Consistency & Quality
+
+This takes into account your consistency over time and the quality of your contributions. You can improve your score in this area by:
+
+#### Contributing consistently over time
+
+Maintaining regular contributions over time will improve your score as OSCR considers a 90-day window.
+
+#### Focusing on quality over quantity
+
+While consistency is important, it's equally important to ensure that your contributions are meaningful and don't just aim to fill a quota. Contributions that are impactful and well-received will improve your score.
+
+#### Being patient
+
+The score considers a 90-day window, so consistent positive contributions will improve your score over time.
+
+### Being a Good Open Source Citizen
+
+This takes into account your overall behavior and engagement in an open source community. You can improve your score in this area by:
+
+#### Avoiding any behavior that could be flagged as spam
+
+Communicate and engage in a reasonable way to avoid being flagged as spam. Remember that most interactions in the open source space are text-based and can be misinterpreted. Therefore, be mindful of your potential tone. Being marked as spam negatively impacts your score and your reputation in the community.
+
+#### Maintaining a positive presence
+
+Ensure your interactions are constructive and respectful, as negative behavior can heavily penalize your score.
+
+#### Helping others
+
+Reviewing PRs and commenting on issues, even when you're not the original author, shows your commitment to helping the community and improves your score. Helping other contributors increases your trust in the community.
+
+Improving your OSCR score is a long-term effort that involves consistently engaging in issues, opening and reviewing PRs, and being a good open source citizen. So be patient with it and remember that the score is a measure of your engagement and contribution to open source, not a reflection of your worth as a developer.
diff --git a/docs/welcome/faqs.md b/docs/welcome/faqs.md
@@ -30,11 +30,14 @@ Create a [Repository Insights Page](https://app.opensauced.pizza/hub/insights) o
 
 On every OpenSauced user profile, in the contributions tab, we display the Pull Requests and Issues that the user has commented on. This is to give a more comprehensive view of the user's contributions to the open-source community. It also provides insight into the contributor's depth of knowledge, collaboration and communication skills, and provides an additional data point for understanding the user's open-source contributions.
 
-
 ### 4. I want to provide feedback on OpenSauced.
 
 We love feedback. Post your suggestion in our [feedback repository](https://github.com/orgs/open-sauced/discussions).
 
+### 5. How is the OSCR calculated?
+
+The OpenSauced Contributor Rating (OSCR) is calculated using a combination of factors that reflect a contributor's overall impact in open source. The OSCR considers contribution quality and consistency, community engagement, project impact, collaboration skills, ecosystem involvement, and reputation. These categories are evaluated over recent activity periods (90 days) to produce a comprehensive score that represents a contributor's value (out of 300 total points) to the open source community.
+
 ## Sync Your GitHub Team
 
 ### 1. I don't see my organization on "Sync your GitHub Team."
@@ -49,7 +52,6 @@ If you're an **owner** of the repository, you can select "Allow select third-par
 
 If you are not an owner of the organization, you will need to check with your organization's owner and request access. For complete instructions, see [this guide](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps).
 
-
 ### 3. Do I need to grant authorization to connect GitHub to OpenSauced?
 
-Yes, auth access through GitHub OAuth is required to link your profile to a workspace/team. As an early stage startup, we chose this method for its simplicity. We also request read-only access to your GitHub organizations to gather Contributor Insights based on public GitHub Teams data. We ensure all data used is public and read-only.
+Yes, auth access through GitHub OAuth is required to link your profile to a workspace/team. As an early stage startup, we chose this method for its simplicity. We also request read-only access to your GitHub organizations to gather Contributor Insights based on public GitHub Teams data. We ensure all data used is public and read-only.
diff --git a/sidebars.js b/sidebars.js
@@ -36,24 +36,29 @@ module.exports = {
       type: "category",
       label: "Guides to OpenSauced",
       collapsed: true,
-      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",
+          label: "OSCR Score Guide",
+          collapsed: true,
+          items: ["opensauced-guides/oscr-score-guide/oscr-guide"],
+        },
+      ],
     },
     {
       type: "category",
@@ -75,11 +80,15 @@ module.exports = {
       type: "category",
       label: "Community",
       collapsed: true,
-      items: ["community/welcome-to-the-community", "community/100-days-of-oss", {
-        type: 'link',
-        label: 'Open Source Education Path',
-        href: 'https://opensauced.pizza/learn/#/',
-      },],
+      items: [
+        "community/welcome-to-the-community",
+        "community/100-days-of-oss",
+        {
+          type: "link",
+          label: "Open Source Education Path",
+          href: "https://opensauced.pizza/learn/#/",
+        },
+      ],
     },
     {
       type: "category",
@@ -91,11 +100,7 @@ module.exports = {
           type: "category",
           label: "Pizza CLI",
           collapsed: true,
-          items: [
-            "tools/pizza-cli/pizza-cli",
-            "tools/pizza-cli/codeowners",
-            "tools/pizza-cli/pizza-action",
-          ],
+          items: ["tools/pizza-cli/pizza-cli", "tools/pizza-cli/codeowners", "tools/pizza-cli/pizza-action"],
         },
         {
           type: "category",
@@ -153,9 +158,7 @@ module.exports = {
           type: "category",
           label: "OpenSauced Writers Guides",
           collapsed: true,
-          items: [
-            "contributing/opensauced-writers-guide/writers-guide",
-          ],
+          items: ["contributing/opensauced-writers-guide/writers-guide"],
         },
       ],
     },
@@ -169,6 +172,5 @@ module.exports = {
         "opensauced-packages/semantic-release",
       ],
     },
-
   ],
 };