Skip to content

Commit f8d4fdb

Browse files
committed
fix: spacings and indentations following markdown rules
1 parent c4a02de commit f8d4fdb

File tree

2 files changed

+22
-8
lines changed

2 files changed

+22
-8
lines changed

docs/opensauced-guides/oscr-score-guide/oscr-introduction.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The OSCR is one way to measure your impact in open source and can act as a posit
1919
## How to Improve Your OSCR Score
2020

2121
OSCR score is calculated based on several factors that can be broadly categorized into the following:
22+
2223
1. [Repository Engagement](#repository-engagement)
2324
2. [Issues & Discussions](#issues--discussions)
2425
3. [Pull Requests](#pull-requests)
@@ -32,72 +33,87 @@ Improving in these areas will help you improve your OSCR score over time.
3233
This considers how you engage with repositories, including repository forks, stars, and commits. You can improve your score in this area by:
3334

3435
#### Starring repositories you genuinely intend to contribute to
36+
3537
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.
3638

3739
#### Forking repositories with the intention to contribute
40+
3841
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.
3942

4043
### Issues & Discussions
4144

4245
This takes into account how you interact with open source repos through issues and discussions. You can improve your score in this area by:
4346

4447
#### Opening meaningful issues
48+
4549
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:
4650

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.
5054

5155
#### Engaging in discussions
56+
5257
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.
5358

5459
#### Reacting to issues and comments
60+
5561
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.
5662

5763
### Pull Requests
5864

5965
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:
6066

6167
#### Opening and merging pull requests
68+
6269
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:
6370

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.
6774

6875
#### Creating quality pull requests regularly
76+
6977
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.
7078

7179
#### Providing thoughtful reviews on PRs
80+
7281
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.
7382

7483
#### Collaborating effectively
84+
7585
Participating in constructive discussions respectfully and in a meaningful way improves your OSCR score.
7686

7787
### Consistency & Quality
7888

7989
This takes into account your consistency over time and the quality of your contributions. You can improve your score in this area by:
8090

8191
#### Contributing consistently over time
92+
8293
Maintaining regular contributions over time will improve your score as OSCR considers a 90-day window.
8394

8495
#### Focusing on quality over quantity
96+
8597
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.
8698

8799
#### Being patient
100+
88101
The score considers a 90-day window, so consistent positive contributions will improve your score over time.
89102

90103
### Being a good open source citizen
91104

92105
This takes into account your overall behavior and engagement in an open source community. You can improve your score in this area by:
93106

94107
#### Avoiding any behavior that could be flagged as spam
108+
95109
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.
96110

97111
#### Maintaining a positive presence
112+
98113
Ensure your interactions are constructive and respectful, as negative behavior can heavily penalize your score.
99114

100115
#### Helping others
116+
101117
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.
102118

103119
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.

docs/welcome/faqs.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ Create a [Repository Insights Page](https://app.opensauced.pizza/hub/insights) o
3030

3131
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.
3232

33-
3433
### 4. I want to provide feedback on OpenSauced.
3534

3635
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
5352

5453
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).
5554

56-
5755
### 3. Do I need to grant authorization to connect GitHub to OpenSauced?
5856

5957
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

Comments
 (0)