Skip to content

docs: document report formats and CSV header behavior#136

Merged
advaitpatel merged 2 commits into
OWASP:mainfrom
ShrijalDubey:update-readme-132
Jul 4, 2026
Merged

docs: document report formats and CSV header behavior#136
advaitpatel merged 2 commits into
OWASP:mainfrom
ShrijalDubey:update-readme-132

Conversation

@ShrijalDubey

@ShrijalDubey ShrijalDubey commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

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

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Code style update (formatting, renaming)
  • Code refactoring (no functional changes)
  • Performance improvement
  • Test update
  • Build / CI configuration
  • Security fix

How Has This Been Tested?

Verified by previewing the Markdown rendering locally to ensure headers, bullet points, code references, and anchor links resolve correctly.

  • Unit tests
  • Manual testing

Test Configuration:

  • Python version: 3.x
  • Operating System: Windows (PowerShell)
  • DockSec version: Local dev branch

Checklist

  • Code follows the style guidelines of this project
  • Self-review completed
  • Hard-to-understand areas are commented
  • Documentation updated where needed
  • No new warnings or errors introduced
  • Tests added that prove the fix or feature works
  • All existing tests pass
  • Dependent changes have been merged and published
  • Spelling checked

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.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 3, 2026

@advaitpatel advaitpatel left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@b62a7d7). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #136   +/-   ##
=======================================
  Coverage        ?   78.37%           
=======================================
  Files           ?       26           
  Lines           ?     4028           
  Branches        ?        0           
=======================================
  Hits            ?     3157           
  Misses          ?      871           
  Partials        ?        0           
Flag Coverage Δ
unittests 78.37% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@advaitpatel advaitpatel merged commit 69918a4 into OWASP:main Jul 4, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[GOOD FIRST ISSUE] Document --format output formats and CSV header-only behavior in README

3 participants