Core Concepts

To see the detailed definition, click > to expand.

Identity

Identity is coming from connectors and is a kind of user account in a specific data source.

This can be for example somebody's GitHub profile, git identity, Slack account, etc.

Identity can be claimed by a user. A single user can have multiple identities in different data sources or even multiple identities of the same data source type.

Identity is unclaimed if it is not yet assigned to any user.

Identity can be marked as bot.

Identity has a data source type and the following properties:

  • Data source.

  • Is a bot flag.

  • Email address (optional).

  • Name (optional).

  • User name (optional).

  • Avatar URL (optional).

User

The user is an LFX profile. The user will have an LFID and can claim identities.

Contributor

A contributor is defined as someone who makes a contribution.

A contributor is either an unclaimed identity or a set of claimed identities (under a single user).

Contributions

Contribution is a kind of activity depending on the data source type.

We only consider activities on repositories that are not disabled and have Insights enabled.

Currently, the contribution is defined as any of the following:

  • Authoring, Co-Authoring, or committing a git commit.

  • Creating/editing confluence page or attachment.

  • Approving/Reviewing a Gerrit changeset/approval.

  • Creating/Closing/Merging/Editing a Gerrit changeset.

  • Adding/Editing a Gerrit comment.

  • Creating/Committing a gerrit patchset.

  • Creating/Closing/Editing a Github/Jira/Bugzilla issue.

  • Commenting on a Gerrit/Jira/Bugzilla issue.

  • GitHub/Jira/Buzzilla assignment.

  • Creating/Closing/Merging/Editing a GitHub pull request.

  • GitHub pull request assignment.

  • Commenting on a GitHub pull request.

  • Editing/Deleting a GitHub comment.

  • Reviewing/Approving/Rejecting/Requesting changes on a GitHub pull request.

  • Being requested a GitHub pull request reviewer.

  • Pusher

  • Watcher

Note: Various reaction types such as GitHub reaction to comment/Issue/PR as contributions are not counted.

New Contributor

A new contributor is someone who contributes the first contribution in a specific time range and can also be in a particular project.

This means that a given contributor should not have any contributions before the current time range start date (for a specific project, we consider a given project's new contributors).

User company affiliation

Users can have multiple company affiliations. Each affiliation has:

  • Date range affiliation starts on a given date and ends on a given date. Both the start and end dates can be unlimited.

  • Project affiliations are specific to a project, so users can have different company affiliations for different projects.

  • Organization.

User affiliations are defined at the user level, so they apply to all claimed identities of users.

Virtual affiliation

Virtual affiliations are defined only for unclaimed non-bot identities, so an identity cannot be a bot and cannot be linked to a user.

An identity is virtually affiliated with a company when the identity's email address domain matches the organization domain defined in a special org_domain table.

Those virtual affiliations are not project specific and have no time ranges.

They are just helpers to allow finding more company affiliations.

Last updated

Copyright © 2022 The Linux Foundation®. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks.