WOSPM0010
Idenditiy
Property | Value |
---|---|
code | WOSPM0010 |
title | INSTALLATION_SECTION |
message | README file should have an installation section. |
type | MetricType::ERROR |
Rationale
README file should contain a section that describes how to install the project. There may be many common wasy of installing things, such as using APT, Yarn, NuGet, or Homebrew. You should consider the variety of uset reading your README is a novice and most of them will need more guidance. Even if your project does not have installation process (a binary to download and use etc.), you should mention it in README.