docs: document report formats and CSV header behavior#136
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #136 +/- ##
=======================================
Coverage ? 78.37%
=======================================
Files ? 26
Lines ? 4028
Branches ? 0
=======================================
Hits ? 3157
Misses ? 871
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Description
Added a dedicated "Report Formats" subsection to the README under the Quick Start area to clarify the available export configurations and document unique output behaviors.
Closes #132
Type of Change
How Has This Been Tested?
Verified by previewing the Markdown rendering locally to ensure headers, bullet points, code references, and anchor links resolve correctly.
Test Configuration:
Checklist
Screenshots (if applicable)
Related Issues / PRs
By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.