Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add maintainers guide section #205

Merged
merged 39 commits into from
Nov 16, 2023
Merged
Changes from 3 commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
7bda3f3
Add maintainers guide section
BekahHW Nov 10, 2023
affe87c
Add contrib list pic
BekahHW Nov 13, 2023
5cfbc0d
Add lists section of guide
BekahHW Nov 13, 2023
f3479f8
Add understanding lists data, first draft
BekahHW Nov 13, 2023
8ca5e50
Revise Understanding lists Data for clarity and brevity
BekahHW Nov 14, 2023
96552d4
Remove spaces
BekahHW Nov 14, 2023
a7dfbbd
Add highlights section
BekahHW Nov 14, 2023
a58d50c
Move gifs to gif folder and update in guide
BekahHW Nov 14, 2023
52e9cc5
Add new pages to sidebar
BekahHW Nov 14, 2023
e14464b
Fix name
BekahHW Nov 14, 2023
23feee1
Update item names
BekahHW Nov 14, 2023
7fe77d5
Use the same title as sidebar label
BekahHW Nov 15, 2023
0031807
Link to guide from insights page
BekahHW Nov 15, 2023
961cda3
Add links to maintainers guide in lists page
BekahHW Nov 15, 2023
c637de0
Update lists to include sync your GitHub Team
BekahHW Nov 15, 2023
b84f7f5
Fix spacing and indentation
adiati98 Nov 15, 2023
f408b80
Fix capitalizations and punctuations
adiati98 Nov 15, 2023
ce4b6b2
Fix typo and adjust wordings in maintainers-guide.md
adiati98 Nov 15, 2023
d081c30
Fix typo and adjust wordings in understanding-insights.md
adiati98 Nov 15, 2023
31178df
Fix typo and adjust wordings in understanding-lists-data.md
adiati98 Nov 15, 2023
0f8b12f
Fix broken internal links
adiati98 Nov 15, 2023
daafd7f
Use same title as sidebar label for Understanding Lists Data
adiati98 Nov 15, 2023
bf32b5f
Bold the ways to add a list and minor fix
adiati98 Nov 15, 2023
5ff11c7
Resolve conflicts
adiati98 Nov 16, 2023
5c6a31e
Change link to FAQ with internal link
adiati98 Nov 16, 2023
e683ea5
Add link to extension
BekahHW Nov 16, 2023
41e1544
Clarify default state of lists
BekahHW Nov 16, 2023
eb7cbae
add missing word
BekahHW Nov 16, 2023
6694441
Clarify Highlights tab
BekahHW Nov 16, 2023
4909e42
remove incorrect description of list dashboard
BekahHW Nov 16, 2023
388b4a4
Simplify sentence
BekahHW Nov 16, 2023
259e27c
Clarify languages
BekahHW Nov 16, 2023
ceb87a3
Remove chrome ext reference
BekahHW Nov 16, 2023
be89fcf
Update docs/maintainers/maintainers-guide.md
BekahHW Nov 16, 2023
4f4f5ae
Change word churn to alumni
adiati98 Nov 16, 2023
7cbc20d
Merge branch 'feature/maintainer-guide' of https://github.com/open-sa…
adiati98 Nov 16, 2023
47368d9
Change capital letters to lowercase
adiati98 Nov 16, 2023
3b79831
Change h4 to h3
adiati98 Nov 16, 2023
2fb312e
Change capital letters to lowercase
adiati98 Nov 16, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/maintainers/maintainers-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ keywords:

OpenSauced is a platform dedicated to empowering maintainers and redefining open source contributions. We offer a GitHub-powered dashboard for tracking contributions and gaining insights into your open source projects. You can customize your Insights Pages and Lists with the repositories you choose and the contributors you want to see.

You can connect with your team and contributors through our platform and invite them to join OpenSauced. We also offer a [GitHub browser extension](../tools/chrome-extension/introduction-to-the-chrome-extension.md) that allows you to view your contributors' OpenSauced profiles and invite them to join OpenSauced with a single click.

## Getting Started

To get started, you will need to create an account on OpenSauced. You can do this by visiting the [app.opensauced.pizza](https://app.opensauced.pizza) and clicking the "Connect with GitHub" button. You will be prompted to sign in with your GitHub account. Once you have signed in, you will be redirected to the OpenSauced dashboard.
Expand Down Expand Up @@ -161,7 +159,7 @@ Finally, it's time to add the details of your highlight. You can add a descripti

Writing an effective highlight is key to attracting contributors to your project. Here are some tips to help you write an effective highlight:

#### Issues
#### Highlighting Issues

1. **Focus on the Problem Solved**: Begin by briefly describing the problem or challenge the issue addresses. This sets the context for why it was important.
2. **Acknowledge Contributor(s)**: Mention the contributor(s) who reported or worked on the issue, recognizing their effort.
Expand Down
Loading