Skip to content

Conversation

@pw-sgr
Copy link
Contributor

@pw-sgr pw-sgr commented Jan 29, 2026

#926

  • Add maintainer documentation directly into Docs
  • Mention the maintainer documentation in CONTRIBUTING.md
  • Add a link to the documentation file in the XML-Documentation of the FileSystemWatcherMock

@pw-sgr
Copy link
Contributor Author

pw-sgr commented Jan 29, 2026

@vbreuss added the general outline and the mentioned events for the watcher. Maintainer.md will link to the individual mocks and have general documentation.

@vbreuss vbreuss requested a review from Copilot January 29, 2026 14:33
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds maintainer documentation for the FileSystemWatcherMock implementation, documenting platform-specific behavior differences for file system events across Linux, Windows, and macOS.

Changes:

  • Added comprehensive documentation tables showing FileSystemWatcher event behavior across different platforms
  • Created maintainer documentation structure in the Docs folder
  • Linked documentation from CONTRIBUTING.md and FileSystemWatcherMock class

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
Docs/FileSystemWatcherMock.md Documents event behavior tables for FileSystemWatcher across platforms with and without subdirectory inclusion
Docs/Maintainer.md Creates maintainer documentation index linking to implementation details
CONTRIBUTING.md Adds reference to maintainer documentation for developers
Source/Testably.Abstractions.Testing/FileSystem/FileSystemWatcherMock.cs Adds XML documentation remarks linking to the FileSystemWatcherMock documentation
Testably.Abstractions.sln Includes new documentation files in the solution under the Docs project section

pw-sgr and others added 2 commits January 29, 2026 15:46
Copy link
Member

@vbreuss vbreuss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @pw-sgr

@vbreuss vbreuss merged commit f41df1f into Testably:main Jan 30, 2026
11 checks passed
@github-actions
Copy link

github-actions bot commented Feb 2, 2026

This is addressed in release v5.1.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants