You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/opensauced-guides/oscr-score-guide/oscr-introduction.md
+22-6Lines changed: 22 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,7 @@ The OSCR is one way to measure your impact in open source and can act as a posit
19
19
## How to Improve Your OSCR Score
20
20
21
21
OSCR score is calculated based on several factors that can be broadly categorized into the following:
22
+
22
23
1.[Repository Engagement](#repository-engagement)
23
24
2.[Issues & Discussions](#issues--discussions)
24
25
3.[Pull Requests](#pull-requests)
@@ -32,72 +33,87 @@ Improving in these areas will help you improve your OSCR score over time.
32
33
This considers how you engage with repositories, including repository forks, stars, and commits. You can improve your score in this area by:
33
34
34
35
#### Starring repositories you genuinely intend to contribute to
36
+
35
37
While starring repos is a great way to show your interest and support for a project, taking time and contributing to your starred repos is even better. And it's a great way to boost your OSCR score.
36
38
37
39
#### Forking repositories with the intention to contribute
40
+
38
41
Forking repos of projects you like is an amazing first step towards contributing to them. Going a step further and contributing to your forked repos will help you improve your OSCR score.
39
42
40
43
### Issues & Discussions
41
44
42
45
This takes into account how you interact with open source repos through issues and discussions. You can improve your score in this area by:
43
46
44
47
#### Opening meaningful issues
48
+
45
49
Opening issues is a good way to ease into making contributions and is very helpful to the project. You can improve your OSCR score by making sure the issues you open are:
46
50
47
-
- Meaningful.
48
-
- Explain the problem clearly.
49
-
- Follow the issue template, if provided.
51
+
- Meaningful.
52
+
- Explain the problem clearly.
53
+
- Follow the issue template, if provided.
50
54
51
55
#### Engaging in discussions
56
+
52
57
Leaving helpful comments on issues and Pull Requests (PRs) through clarifying issues raised or attempting to reproduce reported issues is helpful to the project and is a good way to improve your OSCR score.
53
58
54
59
#### Reacting to issues and comments
60
+
55
61
Reacting to issues and comments is a fun way to engage with the community around an open source project and can be a way to upvote issues you'd like prioritized.
56
62
57
63
### Pull Requests
58
64
59
65
This takes into account the quality of any Pull Requests you make and how they are received. You can improve your score in this area by:
60
66
61
67
#### Opening and merging pull requests
68
+
62
69
Opening PRs is great for your score, but merging your PRs significantly boosts your OSCR score. A few ways you can increase the chances of your PRs being merged are:
63
70
64
-
- Tying your PRs to existing issues or creating issues for them first.
65
-
- Following the project's contribution guidelines.
66
-
- Making small commits and keeping your PRs small.
71
+
- Tying your PRs to existing issues or creating issues for them first.
72
+
- Following the project's contribution guidelines.
73
+
- Making small commits and keeping your PRs small.
67
74
68
75
#### Creating quality pull requests regularly
76
+
69
77
Opening PRs on the regular is great for your score but getting your PRs closed instead of merged can quickly hurt your score. You can reduce the chances of your PRs being closed by avoiding unsolicited PRs and following the above tips for opening PRs.
70
78
71
79
#### Providing thoughtful reviews on PRs
80
+
72
81
Reviewing other contributors' PRs is a great way to help the project's maintainers and contribute towards your score. Keeping your reviews respectful and giving feedback in a kind manner all improve your OSCR score.
73
82
74
83
#### Collaborating effectively
84
+
75
85
Participating in constructive discussions respectfully and in a meaningful way improves your OSCR score.
76
86
77
87
### Consistency & Quality
78
88
79
89
This takes into account your consistency over time and the quality of your contributions. You can improve your score in this area by:
80
90
81
91
#### Contributing consistently over time
92
+
82
93
Maintaining regular contributions over time will improve your score as OSCR considers a 90-day window.
83
94
84
95
#### Focusing on quality over quantity
96
+
85
97
While consistency is important, it's equally important to ensure that your contributions are meaningful and don't just aim to fill a quota. Contributions that are impactful and well-received will improve your score.
86
98
87
99
#### Being patient
100
+
88
101
The score considers a 90-day window, so consistent positive contributions will improve your score over time.
89
102
90
103
### Being a good open source citizen
91
104
92
105
This takes into account your overall behavior and engagement in an open source community. You can improve your score in this area by:
93
106
94
107
#### Avoiding any behavior that could be flagged as spam
108
+
95
109
Communicate and engage in a reasonable way to avoid being flagged as spam. Remember that most interactions in the open source space are text-based and can be misinterpreted. Therefore, be mindful of your potential tone. Being marked as spam negatively impacts your score and your reputation in the community.
96
110
97
111
#### Maintaining a positive presence
112
+
98
113
Ensure your interactions are constructive and respectful, as negative behavior can heavily penalize your score.
99
114
100
115
#### Helping others
116
+
101
117
Reviewing PRs and commenting on issues, even when you're not the original author, shows your commitment to helping the community and improves your score. Helping other contributors increases your trust in the community.
102
118
103
119
Improving your OSCR score is a long-term effort that involves consistently engaging in issues, opening and reviewing PRs, and being a good open source citizen. So be patient with it and remember that the score is a measure of your engagement and contribution to open source, not a reflection of your worth as a developer.
Copy file name to clipboardExpand all lines: docs/welcome/faqs.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,6 @@ Create a [Repository Insights Page](https://app.opensauced.pizza/hub/insights) o
30
30
31
31
On every OpenSauced user profile, in the contributions tab, we display the Pull Requests and Issues that the user has commented on. This is to give a more comprehensive view of the user's contributions to the open-source community. It also provides insight into the contributor's depth of knowledge, collaboration and communication skills, and provides an additional data point for understanding the user's open-source contributions.
32
32
33
-
34
33
### 4. I want to provide feedback on OpenSauced.
35
34
36
35
We love feedback. Post your suggestion in our [feedback repository](https://github.com/orgs/open-sauced/discussions).
@@ -53,7 +52,6 @@ If you're an **owner** of the repository, you can select "Allow select third-par
53
52
54
53
If you are not an owner of the organization, you will need to check with your organization's owner and request access. For complete instructions, see [this guide](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps).
55
54
56
-
57
55
### 3. Do I need to grant authorization to connect GitHub to OpenSauced?
58
56
59
57
Yes, auth access through GitHub OAuth is required to link your profile to a workspace/team. As an early stage startup, we chose this method for its simplicity. We also request read-only access to your GitHub organizations to gather Contributor Insights based on public GitHub Teams data. We ensure all data used is public and read-only.
0 commit comments