chocolatey / chocolatey/choco

Documentation: VirusCheck feature wording is misleading

Open
#2,939 0 comments 0 reactions 0 assignees View on GitHub
0 - Triaging Documentation Enhancement
Dominant language
C#
Stars
11.5k
Forks
960
PR merge metrics
No merged PRs in 30d

Description

### Checklist

- [X] I have verified this is the correct repository for opening this issue.
- [X] I have verified no other issues exist related to my request.

### Is Your Feature Request Related To A Problem? Please describe.

The current explanation of the VirusCheck feature is very sparse and a little misleading:

https://github.com/chocolatey/choco/blob/b6dbc3e0b7321fe88d13403b92027292bc35936f/src/chocolatey/infrastructure.app/builders/ConfigurationBuilder.cs#L303

### Describe The Solution. Why is it needed?

We should clarify that we don't scan _all downloaded packages_, and only specifically the files downloaded by a package during installation.

The current wording could be read as the above, but it could also be read as us scanning all files we download, including nupkgs, which is not the case.

### Additional Context

_No response_

### Related Issues

- https://github.com/chocolatey/docs/issues/546

Contributor guide

Open the contributing guide

Research direction

Open src/chocolatey/infrastructure.app/builders/ConfigurationBuilder.cs at line 303 and review the current VirusCheck wording. Check related issue chocolatey/docs#546 for context, then update the explanation so it clearly distinguishes files downloaded by a package during installation from package archives and other downloads.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.