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

feat: oscr updates #364

Merged
merged 9 commits into from
Aug 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/features/contributor-insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The Contributor Insights feature enables you to categorize, monitor, and analyze

Monitor individual commit histories, track who is actively engaged, identify alumni or new contributors, and even compare the performance of contributors against each other. This encompasses a wide range of metrics such as code commits, created and reviewed pull requests (PRs), as well as issue creation and commenting.

![Contributor Insights Page](../../static/img/lists-page.svg)
![Contributor Insights Page](../../static/img/lists-page.png)

## How to Create a Contributor Insight Page

Expand Down Expand Up @@ -47,7 +47,7 @@ On your Contributor Insight Page, you'll see that each contributor is assigned a
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.
OSCRs are calculated on a rolling 90-day basis across all of a contributor's activity and are out of 300 total points. 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
Expand Down
8 changes: 4 additions & 4 deletions docs/features/dev-card.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ keywords:

The Dev Card feature is what we like to call your "open source business card."

On the front of your card, you see your profile picture, username, the number of pull requests you have created, the number of repositories you contributed to, and a graph icon that describes your activity rate.
On the front of your card, you see your profile picture, username, and your [OSCR](https://opensauced.pizza/docs/welcome/glossary/#oscr) score. Your OSCR score is a metric that measures your open source contributions and engagement.

You'll see the back side of your card when you click it. It shows more information, including your profile's picture and headline, the number of pull requests you have created, the date of your first contribution on GitHub, activity rate, [PR velocity](https://opensauced.pizza/docs/welcome/glossary/#pr-velocity) rate, and a `View Profile` button that takes you to your dashboard.
You'll see the back side of your card when you click it. It shows more information, including your profile headline, the number of pull requests you have created, the date of your first contribution on GitHub, activity rate, [PR velocity](https://opensauced.pizza/docs/welcome/glossary/#pr-velocity) rate, and a `View Profile` button that takes you to your dashboard.

![front and back sides of a dev card](../../static/img/a-dev-card.png)
![front and back sides of a dev card](../../static/img/DevCard.png)

Whether you are just beginning your open source journey or a maintainer looking for more contributors and sponsors, you can share your Dev Card as a snapshot of your contributions, skills, and engagement in the open source community.
Your Dev Card is a snapshot of your contributions, skills, and engagement in the open source community. You can share it on social media, use it to monitor your progress, or show it off to potential employers.

Eager to get your Dev Card? Here's how you can get yours today:

Expand Down
2 changes: 2 additions & 0 deletions docs/maintainers/understanding-contrib-insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ Trends in active contributor numbers can indicate the health of the project comm

A decline in a normally active contributor’s engagement could indicate burnout or dissatisfaction, while a surge in activity might be tied to recent changes or enhancements in the project. Tracking activity levels can help you manage team burnout, understand resource needs, and spot potential issues before they escalate.

Each contributor has an OSCR score that reflects their recent activity and engagement. This score can help you identify key contributors, their recent activity and effectiveness, and recognize impactful contributors.

### Understanding Types of Contributors

#### New Contributors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ You can use this feature to create a list of people you interacted with during y

Contributor Insights can also be used to track other people in your network to reach out to about their contributions.

![Contributor Insights page](../../../static/img/lists-page.svg)
![Contributor Insights page](../../../static/img/lists-page.png)

### Using the Repository Insights Feature to Track the Repositories You Contributed to

Expand All @@ -141,11 +141,11 @@ If you have corresponded with the same core contributors and maintainers over th

### Using Your OpenSauced Dev Card for Networking

Your [OpenSauced Dev Card](../../features/dev-card.md) serves as your "open source business card" to showcase all of your recent open source activities. You will find recent activity concerning the projects you contribute to, the frequency of PRs, and projects you are interested in.
Your [OpenSauced DevCard](../../features/dev-card.md) serves as your "open source business card" to showcase all of your recent open source activities. You will find recent activity concerning the projects you contribute to, the frequency of PRs, and projects you are interested in, as well as your [OSCR](../../welcome/glossary.md#oscr) score.

You can easily share your Dev Card on social media platforms like X/Twitter and LinkedIn to gain attention from potential recruiters and hiring managers.

![OpenSauced Dev card](../../../static/img/a-dev-card.png)
![OpenSauced Dev card](../../../static/img/DevCard.png)

### Reflection and Next Steps

Expand Down
4 changes: 2 additions & 2 deletions docs/opensauced-guides/students-guide/students-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ To get the full benefit of your profile, share it on social media, include a lin

### Your Dev Card

Another fun way to share your open source contributions is through your [Dev Card](../../features/dev-card.md). Your Dev Card is a visual representation of your open source contributions. It includes your profile picture, name, bio, and the number of your latest contributions.
Another fun way to share your open source contributions is through your [Dev Card](../../features/dev-card.md). Your Dev Card is a visual representation of your open source contributions. It includes your [OSCR](../../welcome/glossary.md#oscr), profile picture, name, bio, and the number of your latest contributions.

![dev card](../../../static/img/a-dev-card.png)
![dev card](../../../static/img/DevCard.png)


## Explore: Finding Your Next Open Source Project
Expand Down
2 changes: 1 addition & 1 deletion docs/welcome/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ 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.
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 out of 300 points total 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

Expand Down
Binary file added static/img/DevCard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/lists-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 0 additions & 14 deletions static/img/lists-page.svg

This file was deleted.

Loading