Update CHANGELOG.md and README files #1981
Merged
Conversation
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
As part of this custom agents were created to handle the management of the readmes and changelogs for the future.
There was a problem hiding this comment.
Pull request overview
This PR adds package-specific README files for the four main NuGet packages, updates the CHANGELOG.md with version 3.4.0 release notes, and introduces agent configuration files for automated README and changelog maintenance.
- Added README.md files to all four package directories (DocumentFormat.OpenXml, DocumentFormat.OpenXml.Linq, DocumentFormat.OpenXml.Framework, DocumentFormat.OpenXml.Features)
- Updated CHANGELOG.md with 3.4.0 release notes including new features, performance improvements, bug fixes, and documentation updates
- Created agent configuration files to automate future README and changelog maintenance
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/DocumentFormat.OpenXml/README.md | Adds package README with basic usage example for creating Word documents |
| src/DocumentFormat.OpenXml.Linq/README.md | Adds package README with LINQ-to-XML usage example for querying documents |
| src/DocumentFormat.OpenXml.Framework/README.md | Adds package README explaining the low-level infrastructure package |
| src/DocumentFormat.OpenXml.Features/README.md | Adds package README listing optional feature extensions and their scenarios |
| src/Directory.Build.props | Updates build properties to reference package-specific README files |
| Directory.Build.props | Removes centralized PackageReadmeFile property (moved to src-level) |
| CHANGELOG.md | Adds version 3.4.0 release notes with categorized changes and contributor acknowledgments |
| .vscode/mcp.json | Adds MCP server configuration for GitHub integration |
| .github/agents/readme.agent.md | Creates agent configuration for maintaining README files |
| .github/agents/changelog.agent.md | Creates agent configuration for maintaining CHANGELOG.md |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mikeebowen
approved these changes
Dec 16, 2025
mkaszewiak
approved these changes
Dec 16, 2025
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.
As part of this custom agents were created to handle the management of the readmes and changelogs for the future.