Skip to content

Commit

Permalink
feat: add contrib confidence (#330)
Browse files Browse the repository at this point in the history
* Add contrib confidence to repo page list of features

* Add contributor confidence to glossary

* Add more info on contrib confidence

* Fix formatting

* Reorganize useful section to include high contrib confidence score

* Remove s

* Change node version to 20 in release action

* Update engines
  • Loading branch information
BekahHW authored Jun 12, 2024
1 parent 5724d52 commit 461ef02
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ jobs:
- name: "🔧 setup node"
uses: actions/[email protected]
with:
node-version: 18
node-version: 20

- name: "🔧 install npm@latest"
run: npm i -g npm@latest
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ If a structured learning experience isn’t for you, you can also find a particu

Over the last couple of years, online communities and forums have exploded with opportunity. I’m confident that there is a community that suits your needs out there already (but that doesn’t mean you can’t start your own if you can’t find one!) If you’re not sure where to start OpenSauced offers a lot of different opportunities to be part of a community and ask questions:
- [#100DaysOfOSS](https://docs.opensauced.pizza/community/100-days-of-oss/)
- [OpenSauced Discord](https://discord.gg/opensauced)
- [OpenSauced Community](https://github.com/orgs/open-sauced/discussions)
- [OpenSauced Twitter + Twitter Spaces](https://twitter.com/saucedopen)

Actively participating in communities allows you to seek guidance, ask questions, and contribute your expertise. While mentors can provide awesome guidance, the traditional 1:1 mentorship model might not be the most effective or accessible option for everyone. Redefining mentorship to include various online resources and interactions can empower you to find your own path to success. Remember, it's not about having a single mentor; it's about building a network of support that uplifts and inspires you on your tech journey.
1 change: 0 additions & 1 deletion blog/2023/2023-09-27-open-source-abcs-transparency.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Welcome to our [#100DaysOfOSS series](https://dev.to/opensauced/100daysofoss-gro

<!-- truncate -->


Today, we're covering the letter "T" for Transparency.

**Transparency**: Transparency helps to build trust in open source. Because open source is a collaborative effort, with people from all over the world coming together to develop and maintain projects, transparency is one of the most important strengths of the open source community.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: "Discover how to be a top new contributor this Hacktoberfest. "

If you’ve read any of my previous posts, you know that I’m a fan of redefining contributions. But during Hacktoberfest, there’s more competition for the magic four pull requests (PRs). If we think of it like [Moneyball for engineers](https://opensauced.pizza/blog/moneyball-for-engineers), except limiting it to Hacktoberfest, we realize it's not about hitting home runs; it's about getting on base consistently and making strategic plays that contribute to the overall win. So, how do you become a top contributor during Hacktoberfest?

<!-- truncate -->

![Ham yelling play ball](https://media.giphy.com/media/QtoG24OvehcYUhf7mI/giphy.gif)

## Five Pillars of Hacktoberfest Contribution
Expand Down
28 changes: 28 additions & 0 deletions docs/features/repo-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,37 @@ The charts on our repository pages offer a visual representation of several key
- **Pull Request Dynamics**: Analyze pull request activity by the numbers of pull requests opened, closed, and merged. This provides an overview of collaboration efficiency and code review processes.
- **Stars and Forks Over Time**: The number of stars and forks the project receives over time, illustrating the project's growth in popularity and its spread within the developer community.
- **[Lottery Factor](../welcome/glossary.md#lottery-factor)**: This unique metric highlights the dependency on key contributors. A project is considered vulnerable if 2 or fewer contributors account for 50% or more of the project's contributions. This indicates a potential risk if one of these contributors leaves the project.
- **Contributor Confidence**: This metric predicts the likelihood that users who star or fork a repository will return to make contributions. A higher confidence score indicates a greater probability of these users actively engaging with the repository.
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 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.
##### 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
- **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?
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:
- A **high Contributor Confidence score (e.g., 37-50%)** suggests a welcoming and active repository where your contributions are likely to be seen and valued.
- A **low score (e.g., 1-3%)** might indicate it’s harder for outside contributors to contribute.
- A **score in the range of 30-50%** often indicates a healthy and active project.
- An **exceptionally high score (above 40%)** could have different interpretations depending on the project. For very popular repositories, it might still reflect a strong community. For smaller projects, it could suggest a lower barrier to entry that might lead to a high volume of low-quality contributions or unfinished work.
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.
### Contributor Dashboard
The Contributor Dashboard offers a comprehensive view of all contributors, showcasing the frequency and size of each person’s contributions.
Expand Down
4 changes: 4 additions & 0 deletions docs/welcome/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ The activity ratio in Workspaces is based on pull request commits, issues commen

A contributor who has not been active on a project in the last 30 days.

## Contributor Confidence

Contributor Confidence is a metric that estimates the likelihood of users who star or fork a repository returning to make contributions within a specified time range. It is calculated by analyzing the contribution patterns of these users, considering both their activity in other repositories and their direct contributions to the repository in question. Forks are weighted more heavily than stars, and users who do return to contribute significantly influence the confidence score. This metric helps contributors gauge the activity level of a repository and assists maintainers in understanding user engagement, thereby providing insights into the overall health and vibrancy of the project.

## Contributor Insights

The Contributor Insights feature enables you to categorize, monitor, and analyze different groups of contributors within open source projects. With the Contributor Insights feature, gain granular insights into each contributor's activity and contributions.
Expand Down
4 changes: 2 additions & 2 deletions npm-shrinkwrap.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"version": "1.75.4",
"private": true,
"engines": {
"node": "^18",
"npm": ">=9"
"node": "^18.17.0 || >=20.5.0",
"npm": ">= 9.6.0"
},
"scripts": {
"preinstall": "npx @open-sauced/check-engines",
Expand Down

0 comments on commit 461ef02

Please sign in to comment.