docs: polish marketplace README with Why ODS, pass/fail examples, and dogfooding#10
Merged
Merged
Conversation
… dogfooding badge - Added ODS L1 badge and dogfooding note - Added 'Why ODS?' section with before/after comparison table - Added 'What You'll See' section with passing and failing PR comment examples - Updated artifact listing to include SARIF output
Use github.com/open-delivery-spec/spec for the project badge link.
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
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.
Summary
Polishes the GitHub Marketplace README to serve as the primary adoption entry point for ODS.
Changes
Added
Modified
Why
The validate-action README is the most common entry point for new ODS users (it's what they see on GitHub Marketplace). It needs to immediately answer: what is this, what will I see, and why should I install it.