HasReadmeRule

HasReadmeRule

This rule checks that repository has a README.md defined

Readme file is used to improve the maintanability of our repositories. Readme should at least describe what project does and how project can be built/developed

See https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-readmes for more information about GitHub readmes

To ignore HasReadmeRule validation, use following repository-validator.json

{
    "Version":"1",
    "IgnoredRules": [
        "HasReadmeRule"
    ]
}