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
55 changes: 50 additions & 5 deletions docs/features/contributor-insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,67 @@ Monitor individual commit histories, track who is actively engaged, identify alu

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


## Contributor Insight for Maintainers

Contributor insight 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


## Contributor Insight for Contributors


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

- **Track personal contributions**: If you create a contibutor insight 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.

There are Three ways to add contributors to track:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This repeats information that you have below. Delete it here and keep the section below.


1. **Search for Contributors**: Search for ontributors from repositories in your workspace.
2. **Import Contribuors**: Paste a list of contributors to track on yor workspace.
3. **Sync GitHub Following**: Import users that follow from contributors.

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

## How to Create a Contributor Insight Page

After logging in, navigate to "Insights" in the sidebar. Click the "+" next to it to be presented with options, and select "New Contributor Insight."
After logging in, navigate to your OpenSauced workspace.
Follow these steps:

- Click on the navigation bar of your workspace home page.
- Click on the plus sign beside insight.
- Two options will display, which are ;
- New repository insight and New contributor insight.
- Click on the New contributor insight.
- Then add the contributors by searching for their names or import contributors by syncing your GitHub following.

There are three ways to add a list:
[Contributor Insights Page](https://app.opensauced.pizza/hub/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).

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 Contributor Insight Page from a team in your organization.
3. **Import your GitHub Following**: Connect to your GitHub to create a Contributor Insight Page with all the contributors you follow.

Once your Contributor Insight Page 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.

:::tip
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you removing the tip here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you removing the tip here?

I did not see a tip in the modified file. I saw the tip while I was trying to fix the merge conflict. A reason I removed it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I like the tip because it makes it stand out.

- :::tip

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

:::
By default, your Contributor Insight Page is public. If your Contributor Insight Page is private (a PRO plan feature), only those with access to your Workspace will be able to view it.

By default, your Contributor Insight Page is public. If your Contributor Insight Page is private (a PRO plan feature), only those with access to your Workspace will be able to view it.
Loading