feat: Add OSCR documentation (#358)

* Add OSCR to glossary * Update keywords to reflect OSCR * Add OSCR to contrib insights and repo pages * Remove outdated line of documentation * Clarify the score is across open source contributions * Update docs/features/contributor-insights.md Co-authored-by: Nick Taylor <[email protected]> * Highlight the calculation range --------- Co-authored-by: Nick Taylor <[email protected]>
open-sauced · Jul 30, 2024 · 6e2c010 · 6e2c010
1 parent 2922ade
commit 6e2c010
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 5 deletions.
diff --git a/docs/features/contributor-insights.md b/docs/features/contributor-insights.md
@@ -5,7 +5,10 @@ sidebar_label: "Contributor Insights"
 keywords: 
 - "contributor insights" 
 - "contributors" 
-- "organize" 
+- "open source contributor rating" 
+- "contributor impact"
+- "value of open source contributions"
+- "open source sponsorship"
 - "Monitor Contributors" 
 - "Organize Contributors" 
 - "Contributor Contributor Insights Management" 
@@ -35,4 +38,27 @@ Once your Contributor Insight Page is created, you'll be able to see an overview
 
 :::
 
-By default, your Contributor Insight Page is public. If your Contributor Insight Page is private (a PRO plan feature), only those with access to your Workspace will be able to view it.
+By default, your Contributor Insight Page is public. If your Contributor Insight Page is private (a PRO plan feature), only those with access to your Workspace will be able to view it.
+
+## Open Source Contributor Rating (OSCR)
+
+On your Contributor Insight Page, you'll see that each contributor is assigned an OSCR. The OSCR is a metric to evaluate the engagement and impact of contributors across the entire open source ecosystem. This score aims to give insight into a contributor's involvement and the value they bring to open source communities as a whole.
+
+The OSCR takes into account various factors related to all of the contributor's activity and the quality of their contributions in open source. 
+
+:::info
+OSCRs are calculated on a rolling 30-day basis across all of a contributor's activity. This means the score reflects recent activity and engagement, providing a current snapshot of a contributor's open source involvement rather than a lifetime aggregate.
+:::
+
+### Insights into OSCR
+
+Here are some of the ways, the OSCR can be used:
+
+- Identifying currently active key contributors in a project
+- Evaluating the current health of an open source community
+- Finding potential collaborators based on recent activity
+- Recognizing and rewarding impactful contributors
+- Tracking contributor growth over time
+- Encouraging sustained participation in open source
+
+OSCRs are designed to be a helpful tool in understanding current open source dynamics, but should be considered alongside other factors when evaluating contributors or projects.
diff --git a/docs/features/repo-pages.md b/docs/features/repo-pages.md
@@ -105,8 +105,6 @@ You can find out more about how the OSSF Scorecard works and how to interpret th
 
 ### Contributor Dashboard
 
-The Contributor Dashboard offers a comprehensive view of all contributors, showcasing the frequency and size of each person’s contributions. 
+The Contributor Dashboard offers a comprehensive view of all contributors, showcasing the frequency and size of each person’s contributions. It also includes each active contributors [OSCR](../welcome/glossary.md#oscr).
 
 Currently, only publicly available repositories on GitHub can be viewed through repository pages.
-
-Repository pages provide a way to explore and learn about open source projects on GitHub. While you cannot create or edit them directly on Open Sauced Pizza yet, you can add them to your [Repository Insight pages](https://opensauced.pizza/docs/features/repo-insights/). 
diff --git a/docs/welcome/glossary.md b/docs/welcome/glossary.md
@@ -51,6 +51,10 @@ The name "Lottery Factor" comes from the idea that if a key contributor wins the
 
 A contributor who has recently made their first contribution to a project.
 
+## OSCR
+
+OSCR, or Open Source Contributor Rating, is a metric that evaluates the engagement and impact of contributors in open source projects. The OSCR is calculated on a rolling 30-day basis and looks at all of a contributors open source contributions. This means the score reflects recent activity and engagement, providing a current snapshot of a contributor's involvement rather than a lifetime aggregate.
+
 ## OSSF Scorecard
 
 The Open Source Security Foundation (OSSF) Scorecard is a standardized metric developed by the Open Source Security Foundation to evaluate the security practices of open source projects based on a set of security criteria. These criteria cover various aspects of project maintenance and security practices. The resulting score provides a quick overview of the project's adherence to security best practices.