Skip to content

Commit

Permalink
feat: oscr enhancements (#371)
Browse files Browse the repository at this point in the history
* Add OSCR to repo pages

* Utilize details to make the page more readable

* Update the 100days page

* Close some of the sidebar categories to better organize

* Fix typos and remove here's mine

* Improve structure
  • Loading branch information
BekahHW authored Aug 15, 2024
1 parent dbc2757 commit 51b74a3
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 28 deletions.
33 changes: 25 additions & 8 deletions docs/community/100-days-of-oss.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,16 @@ Here's what you can do if you're ready to join this challenge:

- [Post your commitment today on X](https://twitter.com/intent/tweet?text=I%27m%20joining%20the%20%23100DaysOfOSS%20challenge%20with%20%40saucedopen%20to%20grow%20my%20skills%2C%20gain%20real-world%20experience%20in%20open%20source%2C%20and%20to%20make%20a%20positive%20impact%20on%20the%20OSS%20Community!) or share on your platform of choice!

Your OpenSauced Profile, includes your DevCard, which is a great way to track your progress. Remember, it's not about what the number is today; it's about what the number is at the end of 100 days. Check out [Numbers and Narratives: The Dual Power of Tracking Your Open Source Journey](https://opensauced.pizza/blog/numbers-and-narratives) for more information on effectively tracking your progress and telling your story.

#### How to check your OSCR

Go to your OpenSauced Profile. For example, https://app.opensauced.pizza/u/bekahhw. You can also check out [this contributor insight page](https://app.opensauced.pizza/workspaces/cff3f17b-f052-4686-85af-72971009136b/contributor-insights/545c756a-39e0-4361-b516-9610cb413959/overview) to see the members of our 2024 cohort.

Remember, there's value in knowing the story behind the numbers. When you share your DevCard, tell the story behind your number.

[![DevCard](../../static/img/DevCard.png)](https://app.opensauced.pizza/u/bekahhw/card)

## The Official Kickoff

The #100DaysOfOSS challenge is flexible; you can join whenever you're ready. Just jump in at any point and begin with day one of your personal challenge.
Expand All @@ -76,23 +86,30 @@ Here's what you can do if you're ready to join this challenge:

To make the most of your #100DaysOfOSS journey, here are some additional resources and events you can explore:

1. **Weekly X Spaces:** Join our X Spaces, where we discuss open source topics, share insights, and connect with like-minded individuals. Follow us on [X](https://twitter.com/saucedopen) to stay updated on upcoming sessions.

2. **Community events:** Discover a wide range of events on our [community docs page](https://opensauced.pizza/docs/community/welcome-to-the-community). Whether hack days, workshops, or office hours, these events provide excellent opportunities to learn, collaborate, and find new projects to contribute to.

3. **Contribution opportunities:** If you're actively looking for open source projects to contribute to, check out the [post](https://dev.to/bekahhw/series/23323) for new contribution opportunities.

4. **Discussion Forum:** Have questions or need help? Join us in our [Community](https://github.com/orgs/open-sauced/discussions/1) or post on our [#100DaysOfOSS discussion](https://github.com/orgs/open-sauced/discussions/36). We're here to help you succeed!
1. **Weekly Events:** Join our events, where we discuss open source topics, share insights, and connect with like-minded individuals. Follow us on [X](https://twitter.com/saucedopen) to stay updated on upcoming sessions.
2. **Learning Resources:** Check out our [Learning Resources](https://opensauced.pizza/learn/#/) to find courses, tutorials, and other educational materials to help you grow your skills.
3. **Discussion Forum:** Have questions or need help? Join us in our [Community](https://github.com/orgs/open-sauced/discussions/1) or post on our [#100DaysOfOSS discussion](https://github.com/orgs/open-sauced/discussions/36). We're here to help you succeed!

## Where to Start?

If you're ready to start your #100DaysOfOSS journey, here are some tips to help you get started:

- **Find a project:** Explore the [OpenSauced](https://opensauced.pizza/) website to find a project that interests you. You can also check out the [weekly post](https://dev.to/bekahhw/series/) for exciting contribution opportunities.
- **Find a project:** Explore the [OpenSauced](https://opensauced.pizza/) website to find a project that interests you.
- **Take our Intro To Open Source course:** If you're new to open source, we recommend taking our [Intro to Open Source course](https://opensauced.pizza/learn/#/) to learn more about open source and how to get started.
- **Record your journey:** You will learn a lot as you navigate this challenge, so we highly recommend using our [#100DaysOfOSS journal template](https://github.com/open-sauced/100-days-of-oss-template) on GitHub or [Notion](https://www.notion.so/a0m0rajab/100-Days-Of-Open-Source-2615e66772e14152897002e348c5f1bc?pvs=13) to help you reflect. Remember, this is _your_ journey, so feel free to customize them however you like.
- **Check our Contributors Guide:** If you're new to contributing to open source, we recommend checking out our [Contributors Guide to OpenSauced](https://opensauced.pizza/docs/contributors/contributors-guide-to-open-sauced/) to learn more about the process and best practices.

### Find Projects You're Interested in 🔍

In the Intro to Open Source course, we talk about how to find projects to contribute to. When you contribute, start by understanding the project. Here are some steps you can take:

- Read through the ReadMe of the projects
- Find the contributing.md files and read through those
- Take a look at a Bug Report and Feature Request Issue on each of the repositories. Familiarize yourself with the format and information provided.
- Notice how well clear communication helps to aid the process.

Here's [a post](https://opensauced.pizza/docs/community-resources/how-to-write-a-good-issue-tips-for-effective-communication-in-open-source/) you can read on writing good issues.

## The Power of the #100DaysOfOSS Challenge

The #100DaysOfOSS challenge offers a supportive community where developers can find encouragement, share experiences, and overcome roadblocks together.
Expand Down
52 changes: 35 additions & 17 deletions docs/features/repo-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,7 @@ There are a couple of ways to access a repository page:
If you want to keep track of a repository, use the "Add to WorkSpace" button on the Repo page to add it to your [Workspace](https://opensauced.pizza/docs/features/workspaces/).
:::
## Understanding the Repository Page
### Overview Dashboard
## Understanding the Repository Page - Overview Dashboard
The charts on our repository pages offer a visual representation of key project metrics:
Expand All @@ -58,32 +56,25 @@ The charts on our repository pages offer a visual representation of key project
You can use the time range filter to view the number of stars and forks over different periods, such as the last 7 days, month, or the last year.
#### Insights into YOLO Coders
For small, independent side projects, this method can sometimes be acceptable due to the limited scope and impact of the changes. However, in larger projects with broader adoption, such practices can quickly lead to significant issues, including:
- **Semantic Problems**: Lack of clear commit messages and structured development history can make it challenging to understand the evolution of the project.
- **Communication Breakdowns**: Community members and collaborators may find it difficult to follow ongoing changes, align with the project’s direction, or contribute effectively.
- **Security Risks**: Direct pushes to the default branch can introduce vulnerabilities. For instance, an accidental force push could erase critical history, or worse, a rogue commit could embed malicious code without detection.
- **Quality Control**: By bypassing code reviews and automated checks, YOLO coders risk introducing bugs, breaking existing functionality, or compromising the project’s integrity.
#### Insights into Contributor Confidence
### Insights into Contributor Confidence
Contributor Confidence is a new metric that helps us understand the likelihood of someone who interacts with a repository (by starring or forking it) coming back to actually contribute code or other content.
<details>
<summary>Contributor Confidence is a new metric that helps us understand the likelihood of someone who interacts with a repository (by starring or forking it) coming back to actually contribute code or other content.</summary>
##### How it Works
#### How it Works
We calculate Contributor Confidence as a percentage over a specific time period (usually 30 days). Here’s what we look at:
- **Starred Repositories**: We check if people who starred a repository have contributed to other repositories during the same timeframe. If they have, we see if they also contributed to the starred repository itself.
- **Forked Repositories**: Similar to starred repositories, we check if people who forked a repository have contributed elsewhere recently. We then see if they made a pull request or other contribution to the forked repository.
##### Weighting the Score
#### Weighting the Score
- **Forks**: Forking a repository generally indicates a stronger intent to contribute compared to just starring it. So forks tend to have a slightly higher weighting in the confidence score.
- **Direct Contributions**: If someone actually makes a contribution to the repository in question, their confidence score for that specific repository becomes 100% (the highest weight).
##### Why is it Useful?
#### Why is it Useful?
Understanding Contributor Confidence can help you gauge the health of a repository and its community. Here are a few ways you can interpret the score:
Expand All @@ -94,6 +85,8 @@ Understanding Contributor Confidence can help you gauge the health of a reposito
For **Owners/Maintainers**, Contributor Confidence helps understand recent stars and forks in the context of contributors. A higher score suggests more people who have recently contributed elsewhere or within the repository itself, which can be a positive indicator of the overall health of your repository.
</details>
### Insights into the OSSF Scorecard
The Scorecard serves two primary purposes:
Expand All @@ -103,10 +96,35 @@ The Scorecard serves two primary purposes:
You can find out more about how the OSSF Scorecard works and how to interpret the results on the [OSSF Scorecard website](https://scorecard.dev/#what-is-openssf-scorecard).
### Contributor Dashboard
## Contributor Dashboard
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).
### The OSCR
<details>
<summary>The Open Source Contributor Rating (OSCR) is a metric designed to evaluate the quality, confidence, and sway of a contributor's work in open source projects.</summary>
#### How it works:
The OSCR is calculated using a combination of factors, including:
- **Contributor Confidence**: Assesses how likely a contributor is to continue engaging with projects.
- **Contributor Quality**: Evaluates the overall quality of contributions.
- **Sway**: Measures the contributor's ability to engage with and influence the community through conversations.
##### How it can be used:
- **For maintainers**: Identify key contributors and potential collaborators.
- **For contributors**: Gauge your impact and areas for improvement as well as track your progress in open source projects.
- **For collaborators**: Discover talented developers to collaborate with based on their open source contributions.
- **For companies**: Identify impactful contributors to sponsor or engage with based on their open source contributions.
</details>
Currently, only publicly available repositories on GitHub can be viewed through repository pages.
## Create a Workspace from SBOM
Expand Down
6 changes: 3 additions & 3 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ module.exports = {
{
type: "category",
label: "Guides to OpenSauced",
collapsed: false,
collapsed: true,
items: [{
type: "category",
label: "Job Seekers Guide",
Expand All @@ -58,7 +58,7 @@ module.exports = {
{
type: "category",
label: "Maintainers Guide to OpenSauced",
collapsed: false,
collapsed: true,
items: [
"maintainers/maintainers-guide-to-open-sauced",
"maintainers/understanding-repo-insights",
Expand All @@ -74,7 +74,7 @@ module.exports = {
{
type: "category",
label: "Community",
collapsed: false,
collapsed: true,
items: ["community/welcome-to-the-community", "community/100-days-of-oss", {
type: 'link',
label: 'Open Source Education Path',
Expand Down

0 comments on commit 51b74a3

Please sign in to comment.