Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 2 deletions docs/becoming-a-maintainer/getting-practical.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ Now that you have your project set up, it's time to promote it! Here are some id
- Share your project on social media, forums, and relevant communities.
- Write blog posts or tutorials about your project.
- Present your project at meetups, conferences, or online webinars.
- Create a Highlight on OpenSauced to showcase your project.
- Post about your project on LinkedIn, X (Twitter), or Mastodon for professional visibility.
- Share your project with friends, family, and colleagues.
- Ask for feedback from your network.

Expand All @@ -366,7 +366,7 @@ In order to maintain a healthy project where contributors feel valued, it's impo

- Use tools like the [All Contributors](https://allcontributors.org) bot to acknowledge different types of contributions.
- Highlight contributors in your README or on your project's website.
- Create a Highlight on OpenSauced to showcase contributors.
- Share contributor achievements on social media with a thank-you and link to their PR or issue.
- Thank contributors publicly for their work.

### Monitoring Your Project
Expand Down
19 changes: 11 additions & 8 deletions docs/becoming-a-maintainer/issues-and-pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: issues-and-pull-requests
title: "How to Handle Open Issues and Pull Requests"
sidebar_label: "Managing Issues and Pull Requests"
keywords: ["issues and pull requests", "how to handle issues and pull requests", "issues management in open source", "best practices for issue triage", "managing pull requests open source", "pull requests reviews", "Issue and Pull Request Highlights with OpenSauced", "handling security vulnerabilities in open source", "open source maintainers", "Open Source", "Open Source Community"]
keywords: ["issues and pull requests", "how to handle issues and pull requests", "issues management in open source", "best practices for issue triage", "managing pull requests open source", "pull requests reviews", "showcasing contributor contributions", "handling security vulnerabilities in open source", "open source maintainers", "Open Source", "Open Source Community"]
---

One of the core responsibilities of an open source maintainer is triaging open issues and reviewing pull requests. In this chapter, we will talk about how to best handle open issues, pull requests, and security vulnerabilities.
Expand Down Expand Up @@ -135,21 +135,24 @@ Sometimes, pull requests can remain open for weeks or months at a time. They're

If you have repeatedly tried to reach out and get no response, you should close the pull request or take it over. If you are taking it over, tell the contributor you are bringing this to the finish line because it is blocking other pull requests.

## Issue and Pull Request Highlights with OpenSauced
## Showcasing Contributor Achievements

The [Highlights](https://opensauced.pizza/docs/features/highlights/) feature on OpenSauced is a place for you to showcase recent achievements with the open source community. This is a place to introduce your project to potential new contributors and talk about issues that need attention from the community.

![Highlights GIF](../_assets/gifs/highlight.gif)
Recognizing and showcasing contributor achievements helps build community morale and attract new contributors. Here are effective ways to highlight issues and pull requests:

### Issue Highlights

When writing issue highlights, you will want to talk about the issue, how the contributor solved it, and how the solution impacted the project. Once you post a highlight on OpenSauced, re-share it on other platforms like Twitter or LinkedIn for increased visibility. Regularly acknowledging and thanking your contributors, especially in public, will strengthen their loyalty to the project and attract new contributors.
When showcasing resolved issues, talk about the problem, how the contributor solved it, and the impact of the solution on the project. Share these stories on your project's README, blog, or social media (X, LinkedIn, Mastodon). Regularly acknowledging and thanking contributors in public strengthens their loyalty to the project and demonstrates the kind of contributions you value.

### Pull Request Highlights

When writing pull request highlights, you will want to talk about the changes made, acknowledge the author, and showcase how this improves the project. Link the pull request in your highlight for those interested in taking a closer look at the changes made. This is another way to gain attention for the project because it is a first-hand look at what types of contributions you are looking for and how well you work with contributors.
When highlighting merged pull requests, describe the changes made, acknowledge the author by name and handle, and explain how it improves the project. Always link to the pull request so others can review the work. This gives potential contributors a first-hand look at the types of contributions you welcome and how you collaborate with contributors.

### Where to Share

To learn more about how the Highlights feature works, please read through the [OpenSauced documentation](https://opensauced.pizza/docs/features/highlights/).
- **Project README or CHANGELOG**: Add a "Contributors" or "Recent Contributions" section that links to notable PRs and issues.
- **GitHub profile README or project website**: Feature contributor spotlights or release notes that call out specific contributions.
- **Social media**: Share merged PRs and resolved issues with a thank-you to the contributor. Tag them when appropriate for increased visibility.
- **Release notes and newsletters**: Include contributor acknowledgments in project updates.

## Promptly Respond and Address Concerns

Expand Down
4 changes: 2 additions & 2 deletions docs/becoming-a-maintainer/metrics-and-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,9 +171,9 @@ You can filter your Contributor Insight Page by All Contributors, Active Contrib

![list graph](../_assets/images/list-graph.png)

##### Highlights Dashboard
##### Staying Informed About Contributor Activity

The Highlights dashboard gives you a list of the highlights that the contributors listed on your page have created. This is a great way to see what other contributors are up to and to show them support.
To stay informed about what your contributors are up to and show them support, consider following their activity on GitHub, engaging with their social media posts about contributions, or setting up notifications for their pull requests and issues. You can also acknowledge their work in release notes, README acknowledgments, or community shout-outs.

:::tip

Expand Down
4 changes: 2 additions & 2 deletions docs/intro-to-oss/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ As you work through the course, we encourage you to experiment with the tools an

## Building Your Open Source Resume

One of the unique features of this course is that it guides you to build your open source resume using OpenSauced. OpenSauced is a platform that helps you track and showcase your open source contributions, making it easier to get noticed by potential employers and collaborators.
One of the unique features of this course is that it guides you to build your open source resume. You'll learn how to showcase your contributions using tools like Contributor.info, GitHub profile READMEs, blog posts, and social media—making it easier to get noticed by potential employers and collaborators.

To learn more about using OpenSauced to build your open source resume, check out the "[Building Your Open Source Resume](the-secret-sauce.md#building-your-open-source-resume)" section in "The Secret Sauce" chapter.
To learn more about building your open source resume, check out the "[Building Your Open Source Resume](the-secret-sauce.md#building-your-open-source-resume)" section in "The Secret Sauce" chapter.

## Expectations

Expand Down
2 changes: 1 addition & 1 deletion docs/intro-to-oss/conclusion.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Throughout this course, we've covered a range of topics designed to help you und

- **[How to Contribute to Open Source](how-to-contribute-to-open-source.md)**: We discussed the process of finding projects to work on, submitting contributions, onboarding to new projects, and what happens after your contribution is submitted.

- **[The Secret Sauce](the-secret-sauce.md)**: We shared strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume using OpenSauced.
- **[The Secret Sauce](the-secret-sauce.md)**: We shared strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume using modern tools and platforms.

- **[Types of Open Source Contributions](types-of-contributions.md)**: We shared the coding and non-coding types of contributions in open source, along with examples.

Expand Down
2 changes: 1 addition & 1 deletion docs/intro-to-oss/how-to-contribute-to-open-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -563,4 +563,4 @@ Before resolving merge conflicts, you must first [update your branches](#updatin

<hr/>

As you continue to contribute to open source projects, you'll gain valuable experience, develop new skills, and build a strong portfolio of work. In the [next chapter](the-secret-sauce.md), we'll discuss some strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume using OpenSauced.
As you continue to contribute to open source projects, you'll gain valuable experience, develop new skills, and build a strong portfolio of work. In the [next chapter](the-secret-sauce.md), we'll discuss some strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume.
36 changes: 17 additions & 19 deletions docs/intro-to-oss/the-secret-sauce.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
id: the-secret-sauce
title: "The Secret Sauce"
sidebar_label: "The Secret Sauce"
keywords: ["open source secret sauce", "how to make a lasting impact in open source", "open source resume builder", "building open source resume", "building open source resume with OpenSauced", "finding issues in open source", "addressing issues in open source", "gaining recognition in open source", "building a strong open source profile", "becoming a valuable contributor to open source projects", "tips for building a strong reputation in open source", "effectively highlight open source contributions", "open source contribution", "open source contribution for beginners", "Open Source", "Open Source Community"]
keywords: ["open source secret sauce", "how to make a lasting impact in open source", "open source resume builder", "building open source resume", "finding issues in open source", "addressing issues in open source", "gaining recognition in open source", "building a strong open source profile", "becoming a valuable contributor to open source projects", "tips for building a strong reputation in open source", "effectively highlight open source contributions", "open source contribution", "open source contribution for beginners", "Open Source", "Open Source Community"]
---

In this chapter, we'll share some lesser-known strategies and tips for making a lasting impact in the open source community. We'll discuss how to focus on open issues, gain traction in your contributions, and develop your open source resume using OpenSauced.
In this chapter, we'll share some lesser-known strategies and tips for making a lasting impact in the open source community. We'll discuss how to focus on open issues, gain traction in your contributions, and develop your open source resume.

## Open Issues — More than PRs that Fix Typos

Expand Down Expand Up @@ -41,44 +41,42 @@ As you become more experienced in open source contributions, you may want to inc

## Building Your Open Source Resume

Building a strong open source resume can help you showcase your skills, experience, and contributions to potential employers, collaborators, and the wider developer community. OpenSauced is an excellent tool for tracking your open source contributions and developing your open source resume. Let's look at how you can use OpenSauced to support your open source journey.
Building a strong open source resume can help you showcase your skills, experience, and contributions to potential employers, collaborators, and the wider developer community. Here are several effective ways to build and share your open source portfolio:

1. **Sign up for an OpenSauced account**: if you haven't already created an account, visit [opensauced.pizza](https://opensauced.pizza/) and sign up for an account using your GitHub credentials.
### Portfolio Building Options

2. **Visit Your Public Profile Page**: After signing up, a public profile page will be created for you. This page will display your GitHub profile information and a list of your open source contributions. You can navigate to it by clicking on your username in the top right corner of the page.
1. **[Contributor.info](https://github.com/open-sauced/contributor.info)**: An open-source tool that renders and displays your contribution data. You can use it to create a personalized page showcasing your open source activity across projects.

![Navigating to public profile page at OpenSauced](../_assets/images/opensauced-profile.png)
2. **GitHub Profile README**: Your [GitHub profile README](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme) is a pinned repository that displays at the top of your profile. Use it to highlight your best contributions, link to key pull requests, list projects you've worked on, and add badges or contribution stats. This is often the first thing recruiters and collaborators see.

3. **Build Your Open Source Resume**: From here, you'll be able to add highlights to Pull Requests and Issues that you've contributed to. You can also add a description and links to your open source resume. These will be aggregated into a single page that you can share with others, as well as a summary of your contributions that will be displayed on your public profile page.
3. **Personal Blog Posts**: Write about your contribution experiences—what you learned, challenges you overcame, and the impact of your work. Blog posts demonstrate communication skills and provide context that raw contribution numbers cannot. Platforms like Dev.to, Hashnode, or your own blog work well.

Let's showcase our guestbook contribution from the previous chapter! In your profile, you'll see a "Highlights" section with a text input. When you click this, you'll be able to add a title, some thoughts, and a link to your PR. This will be displayed on your public profile page. Let's add a highlight for our guestbook contribution.
4. **LinkedIn and Social Media**: Share your merged pull requests, completed issues, and project milestones on LinkedIn, X (Twitter), or Mastodon. Professional visibility helps employers discover your work. Consider adding open source contributions to your LinkedIn Experience section or as featured projects.

### Effectively Highlight Your Contributions

Important information to include when you're highlighting your contributions:
Important information to include when showcasing your contributions:

- New material you've created,
- Project details (tools, libraries, size, and complexity),
- The type of your contributions: bug fix, feature, performance, documentation, etc.,
- The details of your contribution including improvements and impacts made on the project and on the community,
- Collaboration and teamwork details.

### Formatting Your Highlight
### Formatting Your Contribution Stories

To be most effective in highlighting your contributions, we recommend using the following format:

- **Description**: When highlighting your contribution, we recommend mentioning the impact that it had on the overall project. This would be helpful in highlighting your qualifications for job positions, especially if you have employment gaps. Consider using the following model to help you craft this highlight into a story:
- **Description**: When describing your contribution, mention the impact it had on the overall project. This is especially helpful when applying for jobs or explaining employment gaps. Consider using this model to craft your story:
- Success verb + noun + metric + outcome.
- Example: While I was reviewing some pull requests for this year's GirlScript Summer of Code, I noticed that most of them would not merge in spite of me and the owner giving approvals. So, I **created a GitHub Action where pull requests automatically merge once they have passed the deployment steps(successive verb + noun)**, which **increased productivity rates by 80%(metric + outcome).**
- **Add a repo**: Provide the complete name of the repository to which you are making contributions.
- **URL**: Paste the URL to your pull request, issue or your blog post.
- Example: While I was reviewing some pull requests for this year's GirlScript Summer of Code, I noticed that most of them would not merge in spite of me and the owner giving approvals. So, I **created a GitHub Action where pull requests automatically merge once they have passed the deployment steps (success verb + noun)**, which **increased productivity rates by 80% (metric + outcome).**
- **Repository**: Provide the complete name of the repository to which you made contributions.
- **URL**: Paste the URL to your pull request, issue, or blog post so others can verify and learn from your work.

![Adding a highlight to a profile at OpenSauced](../_assets/images/opensauced-highlights.png)
### Share Your Portfolio

- **Share it!**: Once you've built up a portfolio of open source contributions, you can share your OpenSauced resume with others by clicking the share button in the header of your profile page. This can be especially helpful when applying for jobs, networking with other developers, or promoting your work in the open source community.
Once you've built up a portfolio of open source contributions, share it widely—in your resume, job applications, social profiles, and when networking with other developers. Consistently showcasing your work helps you stand out in the open source community and the job market.

By leveraging OpenSauced to track your open source contributions and develop your resume, you'll be better equipped to showcase your skills, experience, and impact in the open source community. Additionally, you can refer to the [Job Seekers Guide](https://opensauced.pizza/docs/opensauced-guides/job-seekers-guide/job-seekers-guide-introduction/) in our docs to learn how to use OpenSauced to land a job in the tech industry.

In conclusion, getting started with open source contributions and making a lasting impact on the projects you work on requires a combination of technical skills, collaboration, and persistence. By focusing on open issues, gaining traction in your contributions, and leveraging tools like OpenSauced, you'll be well on your way to a successful and fulfilling open source journey.
In conclusion, getting started with open source contributions and making a lasting impact on the projects you work on requires a combination of technical skills, collaboration, and persistence. By focusing on open issues, gaining traction in your contributions, and actively building and sharing your open source resume through these modern tools and platforms, you'll be well on your way to a successful and fulfilling open source journey.

In the [next chapter](types-of-contributions.md), we will discuss various types of open source contributions.
Loading