scorecard/probes/contributorsFromOrgOrCompany/def.yml

# Copyright 2023 OpenSSF Scorecard Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

id: contributorsFromOrgOrCompany
lifecycle: experimental
short: Checks whether a project has a contributions from users associated with a company or organization.
motivation: >
  This probe tries to determine if the project has recent contributors from multiple organizations.
  For some projects, having a diverse group of contributors is an indicator of project health.
implementation: >
  The probe looks at the Company field on the user profile for authors of recent commits. 
  To receive the highest score, the project must have had contributors from at least 3 different companies in the last 30 commits.
outcome:
  - If the project has no contributing organizations, the probe returns 1 OutcomeFalse
  - If the project has contributing organizations, the probe returns 1 OutcomeTrue per organization.
remediation:
  onOutcome: False
  effort: High
  text:
    - Encourage community-driven contributions to your project.
    - Ask contributors to join their respective organizations, if they have not already. 
    - Otherwise, there is no remediation for this probe; it simply provides insight into how many organizations have contributed so that you can make a trust-based decision based on that information.
ecosystem:
  languages:
    - all
  clients:
    - github
    - gitlab