starred/sharpcompress
1
0
Fork 0
mirror of https://github.com/adamhathcock/sharpcompress.git synced 2026-02-03 21:23:38 +00:00
Code Issues 975 Packages Projects Releases 20 Wiki Activity

[PR #1057] Agent instructions #1485

New Issue
Closed
opened 2026-01-29 22:20:47 +00:00 by claunia · 0 comments
claunia commented 2026-01-29 22:20:47 +00:00
Owner
Copy Link

Original Pull Request: https://github.com/adamhathcock/sharpcompress/pull/1057

State: closed
Merged: Yes

This pull request adds a new documentation file, .github/copilot-instructions.md, which provides comprehensive instructions and guidelines for AI agents (and developers) working on the SharpCompress project. The document covers project architecture, API design patterns, development workflow, code conventions, testing strategies, format-specific knowledge, and common pitfalls, serving as an in-depth onboarding and reference guide.

Key additions in the new documentation:

Project Architecture and API Design:

  • Explains the three-tier API structure (Archive, Reader, Writer), the factory pattern for format detection, and stream disposal rules, including recent changes and best practices.

Development Workflow and Code Conventions:

  • Details build, test, and formatting commands, VS Code tasks, debugging features, and enforces code style rules such as nullable reference types, async/await patterns, and naming conventions.

Testing and Format-Specific Guidance:

  • Outlines testing patterns, organization, and critical test areas; provides format-specific notes for Tar, Zip, Rar, and 7Zip, including limitations and edge cases.

Project Structure and Common Pitfalls:

  • Describes the directory structure and highlights common mistakes to avoid when working with the codebase, such as API misuse and stream handling errors.

Performance Tips and References:

  • Offers performance considerations and
**Original Pull Request:** https://github.com/adamhathcock/sharpcompress/pull/1057 **State:** closed **Merged:** Yes --- This pull request adds a new documentation file, `.github/copilot-instructions.md`, which provides comprehensive instructions and guidelines for AI agents (and developers) working on the SharpCompress project. The document covers project architecture, API design patterns, development workflow, code conventions, testing strategies, format-specific knowledge, and common pitfalls, serving as an in-depth onboarding and reference guide. Key additions in the new documentation: **Project Architecture and API Design:** - Explains the three-tier API structure (Archive, Reader, Writer), the factory pattern for format detection, and stream disposal rules, including recent changes and best practices. **Development Workflow and Code Conventions:** - Details build, test, and formatting commands, VS Code tasks, debugging features, and enforces code style rules such as nullable reference types, async/await patterns, and naming conventions. **Testing and Format-Specific Guidance:** - Outlines testing patterns, organization, and critical test areas; provides format-specific notes for Tar, Zip, Rar, and 7Zip, including limitations and edge cases. **Project Structure and Common Pitfalls:** - Describes the directory structure and highlights common mistakes to avoid when working with the codebase, such as API misuse and stream handling errors. **Performance Tips and References:** - Offers performance considerations and
claunia added the pull-request label 2026-01-29 22:20:47 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
duplicate
enhancement
feedback requested
not bug
pull-request
Mirrored from GitHub Pull Request
 question
up for grabs
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/sharpcompress#1485
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?