Skip to content
oss-kit
GitHubInstall

Every fenced code block in the README says what consumes it

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

A block of text in a box tells a reader nothing about where it goes. Two blocks in a row, one a shell command and one the contents of a configuration file, look identical and get pasted into the same place.

Observable check

every fenced code block in README.md carries a language tag, and every block whose destination is not a shell is preceded by a sentence naming the file, tool, or prompt it goes to.

Read the whole standard