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 information on the graphs in the List page #258

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open
119 changes: 119 additions & 0 deletions docs/features/lists.md
Lymah123 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
---
id: lists
title: "Organize and Monitor Your Contributors"
sidebar_label: "Lists"
keywords:
- "lists"
- "contributors"
- "organize"
- "Monitor Contributors"
- "Organize Contributors"
- "Contributor Lists Management"
---

The OpenSauced Lists feature enables you to categorize, monitor, and analyze different groups of contributors within open source projects. With the Lists feature, gain granular insights into each contributor's activity and contributions.

Monitor individual commit histories, track who is actively engaged, identify alumni or new contributors, and even compare the performance of contributors against each other. This encompasses a wide range of metrics such as code commits, created and reviewed Pull Requests (PRs), as well as issue creation and commenting.

Contributors can use Lists feature to track their own activity, while maintainers can use the feature to manage the community.

![lists-page](../../static/img/lists-page.svg)

## Lists for Maintainers

Lists offer a variety of opportunities to track contributors for various reasons, including:

- **Interacting contributors**: Keep tabs on contributors actively interacting with your repository.

- **Organization's developers**: Monitor the contributions and performance of your internal team.

- **VIP contributors**: Highlight and track at least five developers who are key maintainers or significant contributors.

- **Your GitHub Teams**: Track the activity of your teams to identify if contributors are still active. For example, if you have members on your triage team, you can see their activity level on your repositories to determine if they're still active enough to participate in that role.

- **Potential hires**: Observe contributors who exhibit skill and commitment, making them prime candidates for hiring.

- **Alumni contributors**: Keep an eye on contributors who have decreased their engagement or left the project.

## Lists for Contributors

Lists offer contributors a way to gain insight into the world of open source contributions, including:

- **Track personal contributions**: If you create a list of your personal contributions, you can track them and see how you're doing over time, as well as get a breakdown of the type of contributions you're making, including commits, created PRs, reviewed PRs, and created issues.

- **Learn about what other contributors are doing in open source**: You can learn where other contributors are contributing, what they're working on, and how active they are in the open source community.

- **See who's using OpenSauced Highlights feature**: You can see who's using the Highlights feature and show them support by giving an emoji reaction.

- **Track contributors for job opportunities**: If you're looking for a job, you can track the activity of the contributors you're interested in working with. This helps you understand the activity level of the repositories and the types of contributions being made, and you can even identify which company you want to contribute to.

There are three ways to add a list:

1. **Explore Contributors**: Use our explore tool to find contributors and create your list.
2. **Sync your GitHub Team**: Connect to your GitHub to create a list from a team in your organization.
3. **Import your GitHub Following**:
Connect to your GitHub to create a list with all the contributors you follow.

Once your list is created, you'll be able to see an overview of all the contributors in your list, a graph of their activity, and a detailed breakdown of the contributors.

## How to Create a List

After logging in, navigate to your Lists Page.


## Creating a New List

1. Click the "Lists" tab on the Insights hub to create a new list. You will be redirected to a page where you can create your new list.
2. Click on the "New List" button to start a new list.
3. Give your list a name.
4. Choose your page visibility. You can choose to make your list public or private. By default, it is set to private.
5. Add contributors or maintainers to your list by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following.

![Here](https://docs.opensauced.pizza/assets/images/team-sync-09e7e2ab7b54fae335f5b4c40cce94b1.gif).

## Using Your List

Once you have created your list, you will be redirected to your List Page. Here, you will see a dashboard with an overview of the contributions in your list.

There are three tabs that provide you with more information on these repositories:

## Overview

The Overview tab gives you a high-level view of the contributors in your list, including the total number of commits in the last 30 days and the types of contributors on your list: Active, New, and Alumni.

## Activity

The Activity tab gives you a graph view with more detailed information on each contributor, including the type of activity, repositories they've contributed to, and how they compare to each other.

Lymah123 marked this conversation as resolved.
Show resolved Hide resolved
There's also the Highlights tab that shows any Highlights on OpenSauced that have been made by the contributors on the list.

## Highlight Your Open Source Contributions

The Highlights feature is the place you can display your favorite open source contributions, share the story, and inspire others to join you in your open source journey. For maintainers, it's a great way to showcase your project and the issues that need support and attract new contributors.

There are currently three types of highlights you can add to your profile:

- Dev.to blog post.
- Pull request.
- Issue.

## How to Add a Highlight

- Go to [OpenSauced's Highlights feed](https://app.opensauced.pizza/feed).
- Click the "Post a highlight to show your work!" input.
- Paste the URL to your blog post, pull request, or issue in the bottom input.
- Either use our Auto-Summarize feature or write your own summary.

![Walkthrough](https://docs.opensauced.pizza/assets/images/highlight-e3a2da2446fe91467a31d225755bf40a.gif)

For more examples of highlights, go to the [OpenSauced Highlights feed](https://intro.opensauced.pizza/#/06-the-secret-sauce?id=effectively-highlight-your-contributions).



You can filter your list by All Contributors, Active Contributors, New Contributors, and Alumni Contributors.

![Activity Overview](https://docs.opensauced.pizza/assets/images/list-graph-a730e101fea2e18df0d76faed967f4e6.png)

To learn more about these features, see [Understanding Lists Data](https://docs.opensauced.pizza/maintainers/understanding-lists/).

If you're having trouble syncing your Organization or Team, check out our [Sync Your GitHub Team in our FAQs](../welcome/faqs.md#sync-your-github-team).
Loading