Add Compression best practices guide#52968
Merged
alinpahontu2912 merged 12 commits intoMay 12, 2026
Merged
Conversation
rzikm
reviewed
Apr 10, 2026
rzikm
reviewed
Apr 14, 2026
Member
rzikm
left a comment
rzikm
left a comment
There was a problem hiding this comment.
It's getting better, few additional comments.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new guidance article under File and stream I/O that explains how to work with ZIP and TAR archives in .NET, with a focus on API selection, safe extraction patterns, and operational considerations.
Changes:
- Adds a new best-practices article for ZIP and TAR archives, including security guidance for untrusted input.
- Adds a new C# snippet project and a consolidated
Program.cscontaining the referenced code regions. - Links the new article from
docs/fundamentals/toc.yml.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/standard/io/zip-tar-best-practices.md | New best-practices guide covering API choice, trusted vs. untrusted extraction, memory/perf, platform differences, and encryption notes. |
| docs/standard/io/snippets/zip-tar-best-practices/csharp/Project.csproj | New snippet project targeting net11.0 for compiling the article snippets. |
| docs/standard/io/snippets/zip-tar-best-practices/csharp/Program.cs | Adds the C# snippet implementations referenced by the article. |
| docs/fundamentals/toc.yml | Adds a TOC entry pointing to the new best-practices article. |
Member
|
cc also @GrabYourPitchforks and @blowdart for wording |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
rzikm
reviewed
Apr 28, 2026
MihaZupan
reviewed
May 4, 2026
Member
MihaZupan
left a comment
MihaZupan
left a comment
There was a problem hiding this comment.
It's great we're documenting this, thank you!
It'd be good if we were also able to provide better ways of getting these things right in the first place though.
svick
reviewed
May 4, 2026
adegeo
requested changes
May 7, 2026
Contributor
adegeo
left a comment
adegeo
left a comment
There was a problem hiding this comment.
I'll work on fit-and-finish work, checking xref descriptions where they make sense, maybe changing titles of sections to be actionable, that kind of work.
Member
Author
|
Hey @adegeo thanks for the review! I'd like the guide to be available as soon as possible. If there's anything I can help with on the fit-and-finish work you mentioned, I'm happy to take that on to speed things up. Just let me know :) |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
@alinpahontu2912 I've updated the content. I'll check for any build issues and fix them if they appear. However, you still need to resolve the existing discussions. Cheers! |
adegeo
approved these changes
May 11, 2026
Member
Author
|
Thanks @adegeo ! |
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.
Summary
Add a guide explaining how to best work with Zip and Tar archives in .NET.
Internal previews