Skip to content

docs: clarify data sent outside the machine - #186

Merged
advaitpatel merged 2 commits into
OWASP:mainfrom
dhruvatr:patch-1
Sep 23, 2026
Merged

advaitpatel merged 2 commits into
OWASP:mainfrom
dhruvatr:patch-1

Conversation

@dhruvatr

Copy link
Copy Markdown
Contributor

Pull Request

Description

Summary of the changes and the related issue. Include motivation and context.

Closes #

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?

Describe the tests run to verify the changes:

  • Unit tests
  • Manual testing

Test Configuration:

  • Python version:
  • Operating System:
  • DockSec version:

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

  • Relates to #
  • Depends on #

By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

What does this PR do?

Clarifies the README's data-flow and privacy description.

The previous wording implied that only AI file content could leave the machine, while DockSec also performs EPSS lookups. This update accurately describes the data sent for EPSS and AI analysis and clarifies the behavior of local, scan-only, and offline modes.

Changes

  • Clarified EPSS lookup data flow
  • Clarified AI analysis data flow
  • Clarified local, scan-only, and offline behavior
  • No code changes

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 20, 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, thanks!

@advaitpatel
advaitpatel merged commit 1e80988 into OWASP:main Sep 23, 2026
12 checks passed
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.01%. Comparing base (a2fe184) to head (9496293).
⚠️ Report is 98 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #186      +/-   ##
==========================================
+ Coverage   78.95%   86.01%   +7.06%     
==========================================
  Files          26       53      +27     
  Lines        4158     8117    +3959     
==========================================
+ Hits         3283     6982    +3699     
- Misses        875     1135     +260     
Flag Coverage Δ
unittests 86.01% <ø> (+7.06%) ⬆️

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.

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.

3 participants