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: [SEI-9294]: Adds merge identities docs #8851

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label":"Insights",
"position": 21,
"position": 22,
"collapsible":"true",
"collapsed":"true",
"className":"default",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"label":"Contributors",
"position": 21,
"collapsible":"true",
"collapsed":"true",
"className":"default",
"link":{
"type":"generated-index",
"title":"Contributors"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Manage Contributors
description: Manage contributor attributes and associations.
sidebar_position: 50
sidebar_label: Manage contributors
---

Contributors are developers and other team members that complete actions and activities that contribute to your SEI metrics and insights. Contributors are represented by contributor records in SEI. SEI contributor records serve two primary functions: Account association and Collection association.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: Merge Contributors (BETA)
description: Manage contributor attributes and associations.
sidebar_position: 50
sidebar_label: Merge user profiles (BETA)
---

## Overview

When setting up Software Engineering Insights with multiple integrations, the data ingested by each creates different integration-specific user profiles. SEI uses email addresses to unify these user profiles, but sometimes you might encounter multiple user profiles for the same user.

This happens when the same individual is linked to different accounts across integrations. Managing and merging these profiles ensures accurate data representation and prevents issues like:

* **Incomplete ticket tracking:** Missing links between contributors and associated tasks.
* **Missing commit information:** Difficulty tracking contributions accurately.
* **Fragmented pull request data:** Pull request history appears under multiple users.
* **Inaccurate contributor metrics:** Skewed analytics and performance metrics.

## Connected user accounts

To identify and manage duplicate profiles:

* Navigate to the Contributors section in the SEI dashboard.
* Click on Connected User Accounts to view all user profiles linked to your integrations.

## User profile matching

SEI uses intelligent algorithms to group similar user profiles under two categories: Candidates and Outstanding. The grouping is based on matching criteria that can be customized for specific use cases.

### Matching criteria

* **Email Address (default):** User profiles with the same email are grouped together. You can enable an option to ignore email domains for scenarios where users use different domain emails (e.g., [email protected] and [email protected]).
* **Name:** Match profiles by first name, last name, or a combination of both.
* **Username:** Identify contributors based on unique usernames.
* **No Criteria:** Profiles can be grouped manually without predefined rules.

### Profile categories

Profile categories define how SEI organizes user profiles based on matching criteria:

* Candidates: Groups of profiles automatically matched by SEI based on the chosen criteria. You can review and fine-tune these groups by adding or removing profiles.
* Outstanding: Unmatched profiles that the system couldn’t group. Requires manual intervention to add to existing groups or create new ones.

## Merging contributor profiles

Merging ensures all data associated with multiple user profiles is unified. Follow these steps to merge profiles effectively:

### Step 1: Identify duplicate profiles

* Navigate to Contributors > Connected User Accounts.
* Review the Candidates section:
* Click on a group to expand and view matched profiles.
* Verify that profiles belong to the same individual.
* Adjust groups by adding or removing profiles as needed.

### Step 2: Choose merge options

* Merge Contributors: Instantly merge profiles into a single contributor record.
* Identify as Draft: Save proposed matches for later review.

### Step 3: Finalize and publish changes

* Navigate to the Contributors > Draft tab to review matches saved as drafts.
* Verify details such as:
* Number of new contributors created.
* Profiles added or removed from existing contributors.
* Profiles flagged for deletion.
* Once satisfied, click Publish All Changes to update the contributor records.


:::info
Changes made during merging are irreversible. Use the draft mode to ensure accuracy before publishing.
:::

### Best practices

To maintain clean and accurate contributor records:

* Regular Reviews: Periodically check for duplicate profiles and merge them.
* Verify Matches: Ensure the accuracy of automatic matching before merging.
* Use Draft Mode: Always use the draft feature to review changes in bulk.
* Customize Matching Criteria: Adjust the criteria based on your organization’s specific needs.
Loading