Skip to content

GitHub.Repo.Readme.md

Latest commit

 

History

History
25 lines (16 loc) · 792 Bytes

GitHub.Repo.Readme.md

File metadata and controls

25 lines (16 loc) · 792 Bytes
category Repository
severity Important
online version https://github.com/microsoft/PSRule.Rules.GitHub/blob/main/docs/en/rules/GitHub.Repo.Readme.md

Use a README file

SYNOPSIS

Use a README.md file in the default branch to explain the project and provide information.

DESCRIPTION

When someone visits the repository homepage the README.md in the default branch is automatically shown. For public projects, README is included in GitHub's community profile scorecard.

RECOMMENDATION

Consider creating a README.md file in repository default branch to provide information about the project.

LINKS