README and PR comment: clearer, standard wording#175
Merged
Conversation
Reframe the tagline from detection-led ("comparing specs and detecting
breaking changes") to the product category: every PR becomes an API change
review (free: detect + post the review; Pro: approve/reject + merge gate).
Detection stays accurate, framed as what the free actions do. Matches the
oasdiff.com homepage hero.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The action README is an OSS/community surface; describe what the actions do (check specs for breaking changes on PRs, post a side-by-side review, Pro adds approve/reject + a merge-gating status check) rather than leading with product positioning slogans. The 'API change review / code review for your API contract' framing stays on the marketing site. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> EOF )
The PR comment + CI notices are community surfaces. Replace our coinage
('merge gate', 'gates merge') with standard GitHub terms a developer expects:
'status check', 'check passes', 'required check to block merging'.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
reuvenharrison
changed the title
reuvenharrison
changed the title
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.
Clarifies the wording on the action's README and on the PR comment it posts. Copy only, no behavior change.