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
Prev Previous commit
enhancement: use 3rd person
FatumaA committed Oct 30, 2024
commit 379333833430875e0b9e9c711e91c7cb4f12f71e
30 changes: 15 additions & 15 deletions docs/welcome/key-metrics-guide.md
Original file line number Diff line number Diff line change
@@ -10,53 +10,53 @@ keywords:
- "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.
Welcome to the Key Metrics Guide, where we define the main metrics used on our platform to help users better understand them.

## OSCR

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

This helps you understand the quality and frequency of your contributions. It's a good way to measure your open source activities and takes into account many factors.
This metric helps to determine the quality and frequency of a contributor's contributions. It is determined by their ability to engage in conversations about their work and the project, their rate of contributions to the projects they engage with, and the quality of their contributions.

You can read more about [what it is and how to improve it](../../opensauced-guides/oscr-score-guide/oscr-guide/).
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's measured as a percentage calculated over a specified time range.
[Contributor Confidence](../glossary/#contributor-confidence) is a metric that measures how likely users 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 is welcoming to new contributors or that those who interact with the project are willing to support the project through contributions.
This helps potential users understand whether the project welcomes new contributors. A positive score implies that the project is welcoming, that contributions are likely to be accepted, and that participation in the community is nurtured.

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

## OpenSSF Score

[The 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's 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.

[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).

This helps you evaluate how secure a repository is and how attentive maintainers are to compliance issues. It's also a good metric to evaluate whether or not a repo is secure. Users can see the security scores of all their dependencies.
This helps users understand and 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.

Additionally, you can create [SBOMs (Software Bill of Materials)](../../../features/repo-pages/#create-a-workspace-from-sbom) for projects you use or want to contribute to. This contains a list of all the parts used to build a software including dependencies and libraries. You can read more about [SBOM here](https://opensauced.pizza/blog/security-and-SBOMs).
Additionally, [SBOMs (Software Bill of Materials)](../../../features/repo-pages/#create-a-workspace-from-sbom) can be created for projects used. This contains a list of all the parts used to build software, including dependencies and libraries. Read more about [SBOM here](https://opensauced.pizza/blog/security-and-SBOMs).

You can read more about [what it is and why it is important](https://opensauced.pizza/blog/introducing-openssf-scorecard-for-opensauced).
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.
This helps users understand whether a repository is at risk of abandonment should a key contributor become unavailable. This information is particularly important if a contributor plans to remain a long-term contributor or if a 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).
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 in-depth information sources. It suggests holistically treating repositories by considering GitHub discussions, issues, and general activity and considering the history of entire repositories.

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.
This is helpful, as having more context around a repository can make 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).
Read more about [the case for treating repositories as datasets and why that is important](https://opensauced.pizza/blog/github-repos-as-datasets).

## YOLO Coders

@@ -66,4 +66,4 @@ Proposing changes through PRs helps increase visibility and offers an opportunit

Using PRs and established means of making code changes reduces the chances of project bugs and preserves project history.

You can read more about [what it is and why it is not the best practice](https://opensauced.pizza/blog/yolo-coder).
Read more about [what it is and why it is not the best practice](https://opensauced.pizza/blog/yolo-coder).