From fa4288c1e41f652ff577a687034597a2da4150df Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Sat, 26 Oct 2024 15:52:10 +0300 Subject: [PATCH 01/13] chore: add key metrics guide entry to sidebar --- sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sidebars.js b/sidebars.js index 81cb8227..b16b2cb5 100644 --- a/sidebars.js +++ b/sidebars.js @@ -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", From f4cf02cef220650eb2f4b9f6131589ba7e812e12 Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Sat, 26 Oct 2024 15:53:07 +0300 Subject: [PATCH 02/13] feat: add key metrics guide file and front matter --- docs/welcome/key-metrics-guide.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/welcome/key-metrics-guide.md diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md new file mode 100644 index 00000000..b28e5207 --- /dev/null +++ b/docs/welcome/key-metrics-guide.md @@ -0,0 +1,11 @@ +--- +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" +--- From 01213cba7a2654229556b4a22d3c605efbdad3db Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Sat, 26 Oct 2024 16:20:32 +0300 Subject: [PATCH 03/13] docs: add OSCR section --- docs/welcome/key-metrics-guide.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md index b28e5207..24a79a0d 100644 --- a/docs/welcome/key-metrics-guide.md +++ b/docs/welcome/key-metrics-guide.md @@ -9,3 +9,13 @@ keywords: - "Key metrics guide" - "Open Source metric guide" --- + +Welcome to Key Metrics Guide, where we define main metrics used on our platform to help you understand them better. + +## 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/). From a96847056b93f04307c3a7e3a88bb8c9075e3f1a Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Sat, 26 Oct 2024 16:44:18 +0300 Subject: [PATCH 04/13] fix: update links to use relative paths --- docs/welcome/key-metrics-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md index 24a79a0d..24a84875 100644 --- a/docs/welcome/key-metrics-guide.md +++ b/docs/welcome/key-metrics-guide.md @@ -14,8 +14,8 @@ Welcome to Key Metrics Guide, where we define main metrics used on our platform ## 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. +[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/). +You can read more about [what it is and how to improve it](../../opensauced-guides/oscr-score-guide/oscr-guide/). From ab78ce93a4170e78f4d728b0664d874f022ba952 Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Sat, 26 Oct 2024 17:40:47 +0300 Subject: [PATCH 05/13] docs: add contributor confidence section --- docs/welcome/key-metrics-guide.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md index 24a84875..c6ad9529 100644 --- a/docs/welcome/key-metrics-guide.md +++ b/docs/welcome/key-metrics-guide.md @@ -19,3 +19,11 @@ Welcome to Key Metrics Guide, where we define main metrics used on our platform 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 is welcoming to new contributors, that your contributions are likely to be accepted, and that your 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) From 7d5bd27a5f13649b195f92ddf87d73b7efebe6bc Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Sat, 26 Oct 2024 19:20:31 +0300 Subject: [PATCH 06/13] docs: add OSSF section --- docs/welcome/key-metrics-guide.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md index c6ad9529..78c58862 100644 --- a/docs/welcome/key-metrics-guide.md +++ b/docs/welcome/key-metrics-guide.md @@ -27,3 +27,13 @@ You can read more about [what it is and how to improve it](../../opensauced-guid 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, that your contributions are likely to be accepted, and that your 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) + +## 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. + +[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 is a good metric to consider when contributing to a repository. + +You can read more about [what it is and why it is important](https://opensauced.pizza/blog/introducing-openssf-scorecard-for-opensauced) From 1d7b10328fe9d0a63b7f883a7c20de2339ef0a38 Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Sat, 26 Oct 2024 20:08:23 +0300 Subject: [PATCH 07/13] docs: add lottery factor section --- docs/welcome/key-metrics-guide.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md index 78c58862..cbaeec35 100644 --- a/docs/welcome/key-metrics-guide.md +++ b/docs/welcome/key-metrics-guide.md @@ -26,7 +26,7 @@ You can read more about [what it is and how to improve it](../../opensauced-guid 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, that your contributions are likely to be accepted, and that your 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) +You can read more about [what it is and how it can be interpreted](../../features/repo-pages/#insights-into-contributor-confidence). ## OpenSSF Score @@ -36,4 +36,12 @@ You can read more about [what it is and how it can be interpreted](../../feature 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. -You can read more about [what it is and why it is important](https://opensauced.pizza/blog/introducing-openssf-scorecard-for-opensauced) +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). From 19d5937c84b30f31bb73e79b3ad84a598804ca66 Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Sat, 26 Oct 2024 20:40:21 +0300 Subject: [PATCH 08/13] docs: add repositories as a dataset section --- docs/welcome/key-metrics-guide.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md index cbaeec35..9d134467 100644 --- a/docs/welcome/key-metrics-guide.md +++ b/docs/welcome/key-metrics-guide.md @@ -45,3 +45,13 @@ You can read more about [what it is and why it is important](https://opensauced. 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. + +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 to all. + +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). From 9320d169ecd0069550a1c2842e045d1e5865692e Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Sat, 26 Oct 2024 20:44:39 +0300 Subject: [PATCH 09/13] fix: flow check to tighten up the draft --- docs/welcome/key-metrics-guide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md index 9d134467..00a0d301 100644 --- a/docs/welcome/key-metrics-guide.md +++ b/docs/welcome/key-metrics-guide.md @@ -10,7 +10,7 @@ keywords: - "Open Source metric guide" --- -Welcome to Key Metrics Guide, where we define main metrics used on our platform to help you understand them better. +Welcome to the Key Metrics Guide, where we define the main metrics used on our platform to help you better understand them. ## OSCR @@ -24,7 +24,7 @@ You can read more about [what it is and how to improve it](../../opensauced-guid [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 is welcoming to new contributors, that your contributions are likely to be accepted, and that your participation in the community is nurtured. +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. You can read more about [what it is and how it can be interpreted](../../features/repo-pages/#insights-into-contributor-confidence). @@ -50,7 +50,7 @@ You can read more about [what it is and how it can be interpreted](https://opens [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. -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 to all. +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. From fa46671ad8d4c92640174ac5f8e2e8ce8aaf2cbc Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Tue, 29 Oct 2024 13:43:38 +0300 Subject: [PATCH 10/13] fix: grammar, word choice, sentence structure --- docs/welcome/key-metrics-guide.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md index 00a0d301..d975213b 100644 --- a/docs/welcome/key-metrics-guide.md +++ b/docs/welcome/key-metrics-guide.md @@ -14,27 +14,27 @@ Welcome to the Key Metrics Guide, where we define the main metrics used on our p ## 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. +[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. -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. +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. 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. +[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. -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. +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. 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. +[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). +[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 is a good metric to consider when contributing to a repository. +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. You can read more about [what it is and why it is important](https://opensauced.pizza/blog/introducing-openssf-scorecard-for-opensauced). @@ -48,7 +48,7 @@ You can read more about [what it is and how it can be interpreted](https://opens ## 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. +[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. From f906c4d7dac7195e73cf9bd97dad625da388c788 Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Tue, 29 Oct 2024 15:05:59 +0300 Subject: [PATCH 11/13] docs: add yolo coders section --- docs/welcome/key-metrics-guide.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md index d975213b..dfa96810 100644 --- a/docs/welcome/key-metrics-guide.md +++ b/docs/welcome/key-metrics-guide.md @@ -55,3 +55,13 @@ In the context of AI and its role in aiding developers, treating Repositories as 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). + +## YOLO Coders + +[YOLO Coders](../glossary/#yolo-coders) refers to repository owners, contributors or maintainers who push code changes directly to a project's default branch without going through a pull request (PR). + +Proposing changes through PRs helps increase visibility and offers an opportunity for code reviews and discussions. This increases collaboration and makes potential contributors more likely to engage. + +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). From a1dee8d606d859f571fa1c208b3ce8e9a41f6df7 Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Tue, 29 Oct 2024 15:18:55 +0300 Subject: [PATCH 12/13] docs: tie SBOM to OSSF --- docs/welcome/key-metrics-guide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md index dfa96810..4de99e2d 100644 --- a/docs/welcome/key-metrics-guide.md +++ b/docs/welcome/key-metrics-guide.md @@ -36,6 +36,8 @@ You can read more about [what it is and how it can be interpreted](../../feature 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. +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). + You can read more about [what it is and why it is important](https://opensauced.pizza/blog/introducing-openssf-scorecard-for-opensauced). ## Lottery Factor From 379333833430875e0b9e9c711e91c7cb4f12f71e Mon Sep 17 00:00:00 2001 From: FatumaA <67555014+FatumaA@users.noreply.github.com> Date: Wed, 30 Oct 2024 12:01:55 +0300 Subject: [PATCH 13/13] enhancement: use 3rd person --- docs/welcome/key-metrics-guide.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/welcome/key-metrics-guide.md b/docs/welcome/key-metrics-guide.md index 4de99e2d..884b6cd2 100644 --- a/docs/welcome/key-metrics-guide.md +++ b/docs/welcome/key-metrics-guide.md @@ -10,23 +10,23 @@ 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 @@ -34,19 +34,19 @@ You can read more about [what it is and how it can be interpreted](../../feature [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 @@ -54,9 +54,9 @@ You can read more about [what it is and how it can be interpreted](https://opens 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).