ci: add README quality review on PRs#118
Open
iteebz wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds README Review — a free GitHub Action that scores README quality on every PR and posts a report card comment with a letter grade (0–100).
No API keys needed. Catches README documentation drift before it ships.
What it checks: structure, code examples, installation instructions, description clarity. Only triggers when README.md changes — zero noise otherwise.
See your grade first: grade danielpigott/cloudflare-cli's README instantly — same heuristic, no install, in your browser. If it's useful, this action runs it on every PR.