Beef up the README #35
Merged
Conversation
This file contains 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
cansavvy
approved these changes
Mar 20, 2024
There was a problem hiding this comment.
This is great! This was long overdue (I never got around to it) so thanks for putting this together! I just have minor comments -- no need for me to review again.
The main comment is I think we should keep the usage information that was there toward the top of the document if that's okay. It's super useful to have what you've written for our own purposes (or if people want to contribute) but not everyone will need to know or will care about how ottr-reports works.
But the content itself looks great!
README.md
Outdated
| 8. Based on the number of errors relative to error_min, different actions are taken. If there are too many errors, it fails the job; otherwise, it acknowledges the acceptable error count. | ||
| 9. Comments are made or updated on the pull request to reflect the outcome of the checks, providing feedback directly in the PR discussion. | ||
|
|
||
|
|
||
| ## Inputs |
There was a problem hiding this comment.
This Usage information should probably be at the top? I love the information above but a person doesn't need to know all of it if they just want to use ottr-reports.
Co-authored-by: Candace Savonen <[email protected]>
Closed
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.
Add details on the two yml files for Github Actions:
main.ymlandreport-maker.ymlby providing the purpose and steps of each file.