DOS5030

Repository should always have a description

DOS5030

GitHub repository low builtIn

Description

Make sure to provide a description for your repository. Adding a description will help users understand its purpose and when to use it. Learn more: https://docs.github.com/en/enterprise-cloud@latest/repositories/creating-and-managing-repositories/creating-a-new-repository

Recommendation

1. Go to your Repository. 
2. Select the 'Code' section. 
3. Under the 'About' section, click on the settings icon to edit the repository details. 
4. Ensure the 'Description' field is not empty. Provide a short description of this repository.

Policy Rule

{
  "target": "GHRepository",
  "if": {
    "allOf": [
      {
        "resource": "GHRepository",
        "property": "Description",
        "operator": "notEquals",
        "value": ""
      }
    ]
  },
  "then": {
    "effect": "Audit"
  }
}
« DOS5020 DOS5040 »
Rule Details
  • Rule ID: DOS5030
  • Code: GH_Repository_Should_Have_Description
  • Platform: GitHub
  • Category: repository
  • Severity: low
  • Type: builtIn
Related Rules

Copyright © DevOps Shield. All Rights Reserved. Privacy Policy | Cookie Policy | Terms and Conditions