Skip to content
oss-kit
GitHubInstall

The README links to the license, the changelog, and the contributing guide

Rule
R-DOC-03
Forge scope
GitHub and GitLab
Fixed by
oss-readme

These three files answer whether a reader may use the project, what changed since they last looked, and how to send a fix. A link that resolves to nothing is worse than no link, because it costs a click to learn the file is missing.

Observable check

README.md contains links whose targets are the license file, CHANGELOG.md, and CONTRIBUTING.md, and each target exists in the repository.

Read the whole standard