feat: update and expand rule set - #2
Open
jgagne wants to merge 4 commits into
Open
Conversation
New rules: - ApifyContent: README-specific checks (pricing format, input tab phrasing, placeholder output, platform scaling filler, backticked product names) - ApifyDocs: alt text quality (8 rules), description/heading redundancy - ApifyUI: gerund detection, blame language, verbose confirmations, performative emotion, ambiguous connectors, compliance language No severity promotions or removals.
jgagne
marked this pull request as ready for review
August 14, 2026 14:44
Catches phrases that cite a UI surface as evidence rather than stating facts directly. Source provenance belongs in issues files, not public copy. Patterns detected: - The [surface] says/shows/lists... - According to the [surface]... - As listed/shown/described on/in the [surface]... - Based on the [surface]... Surfaces: Pricing tab, Store page, Input tab, API docs, input schema, output schema, OpenAPI schema, Store listing, README.
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
2 participants
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.
New rules across all four styles (ApifyContent, ApifyDocs, ApifyUI, Apify). Updated existing rules with expanded patterns and improved messages.
No severity promotions or removals.
New rules:
Next steps before merge: