docs/required-files
Checks that every scope has a README.md and the root has a LICENSE.
Part of the docs configuration, at the all level. It runs at the commit stage, per file. gspot runs this check itself.
A scope with no README leaves readers to guess what it does.
What to do
Section titled “What to do”Add a README.md that says what the scope does and how to use it, and a LICENSE file at the root.
Example
Section titled “Example”A scope without README.md reports the missing file. Add one that explains what the scope does and how to start.
Turn it off
Section titled “Turn it off”Turn it off for some files, with a reason:
gspot ignore docs/required-files --paths "<glob>" --reason "<why>"