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: add section for key metrics guide #412

Merged
57 changes: 57 additions & 0 deletions docs/welcome/key-metrics-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
id: key-metrics-guide
title: "Key Metrics Guide"
sidebar_label: "Key Metrics Guide"
keywords:
- "metrics"
- "openSauced"
- "OpenSauced metrics guide"
- "Key metrics guide"
- "Open Source metric guide"
---

Welcome to the Key Metrics Guide, where we define the main metrics used on our platform to help you better understand them.

## OSCR

[OSCR](../glossary/#oscr) stands for Open Source Contributor Rating. It is a way to measure and rate the impact of your open-source contributions over 90 days.

This helps you understand the quality and frequency of your contributions. It is a good way to measure your open source activities and takes into account many factors.

You can read more about [what it is and how to improve it](../../opensauced-guides/oscr-score-guide/oscr-guide/).

## Contributor Confidence

[Contributor Confidence](../glossary/#contributor-confidence) is a metric that measures how likely contributors who have interacted with a repository via stars or forks are to contribute in some way. It is measured as a percentage calculated over a specified time range.

This helps you evaluate whether a repository you are interested in provides a good environment for new contributors. A positive score implies that the project welcomes to new contributors, that your contributions are likely to be accepted, and that your participation in the community is nurtured.
FatumaA marked this conversation as resolved.
Show resolved Hide resolved

You can read more about [what it is and how it can be interpreted](../../features/repo-pages/#insights-into-contributor-confidence).

## OpenSSF Score

[OpenSSF Score](../glossary/#ossf-scorecard) is a metric that measures how secure an open-source project is based on how compliant the repository is to OpenSSF’s standards. It is scored out of 10 and uses [OpenSSF’s CLI tool](https://scorecard.dev/#what-is-openssf-scorecard) under the hood to help calculate this score.
FatumaA marked this conversation as resolved.
Show resolved Hide resolved

[OpenSSF](https://openssf.org) refers to the Open-source security foundation, a group of security-focused tech professionals who are trying to enable the open-source ecosystem to create safe, open software in compliance with the [EU’s Cyber Resilience Act](https://digital-strategy.ec.europa.eu/en/policies/cyber-resilience-act).
FatumaA marked this conversation as resolved.
Show resolved Hide resolved

This helps you evaluate how secure a repository is and how attentive maintainers are to compliance issues. It is a good metric to consider when contributing to a repository.
FatumaA marked this conversation as resolved.
Show resolved Hide resolved

You can read more about [what it is and why it is important](https://opensauced.pizza/blog/introducing-openssf-scorecard-for-opensauced).

## Lottery Factor

[Lottery Factor](../glossary/#lottery-factor) is a metric that measures the risk that comes with a project’s dependence on one or a few key contributors. It measures how many pull requests are made by the most active contributors as a percentage.

This helps you understand whether or not a repository is at risk of abandonment should a key contributor become unavailable. This information is particularly important if you plan on being a long-term contributor or if your project relies on an open-source project for the long term.

You can read more about [what it is and how it can be interpreted](https://opensauced.pizza/blog/Understanding-the-Lottery-Factor).

## Repositories as a Dataset

[Repositories as a Dataset](../glossary/#repository-insights) refers to viewing repositories as complete and indepth information sources. It suggests holistically treating repositories by considering GitHub discussions, issues, and general activity and considering the history of entire repositories.
FatumaA marked this conversation as resolved.
Show resolved Hide resolved

In the context of AI and its role in aiding developers, treating Repositories as a dataset helps train more context-aware AI models and makes this information more accessible.

This is helpful, as having more context around a repository you want to contribute to can make the process of contributing and onboarding much smoother.

You can read more about [the case for treating repositories as datasets and why that is important](https://opensauced.pizza/blog/github-repos-as-datasets).
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ module.exports = {
type: "category",
label: "Getting Started",
collapsed: false,
items: ["welcome/opensauced-intro", "welcome/glossary", "welcome/faqs"],
items: ["welcome/opensauced-intro", "welcome/key-metrics-guide", "welcome/glossary", "welcome/faqs"],
},
{
type: "category",
Expand Down
Loading