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
72 changes: 69 additions & 3 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
Expand Up @@ -11,15 +11,45 @@ keywords:
- "Contributor Lists Management"
---

The 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.
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)

## How to Create a List
## Why Create Lists for Contributors and Maintainers?
Lymah123 marked this conversation as resolved.
Show resolved Hide resolved

Creating lists for both contributors and maintainers offers a wealth of benefits, enhancing collaboration and building a stronger open-source community. There are many reasons to create a lists, but here are some inspiration to get you started either as a contributor or a maintainer:

_For Maintainers_

There are many reasons to create a list, but here's some inspiration to get you started:

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

- **Sales leads**: Identify contributors whose engagement could potentially be turned into sales opportunities.
Lymah123 marked this conversation as resolved.
Show resolved Hide resolved

After logging in, navigate to your [Lists Page](https://app.opensauced.pizza/hub/lists/).
- **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.

_For Contributors_

There are many things you can do with this feature, but here are some ideas to get you started:

- **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:

Expand All @@ -30,4 +60,40 @@ There are three ways to add a list:

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.
There's also the Highlights tab that shows any Highlights on OpenSauced that have been made by the contributors on the list.

Lymah123 marked this conversation as resolved.
Show resolved Hide resolved
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