You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Implements #234 — repo hygiene: remove stale generated artefacts and IDE metadata from source control.
The artefacts originally named in the issue (src/Common/Ploch.Common.xml, tests/**/*.cs.bak) turned out to be already resolved by earlier cleanups (.gitignore:398 ignores the XML; *.bak is ignored at line 362 and no .bak files remain). This PR completes the issue's intent by sweeping the remaining instances of the same problem class.
Changes
Removed src/Common.Serialization.NewtonsoftJson/Ploch.Common.Serialiation.NewtonsoftJson.xml — a stale generated XML documentation file (note the typo in its name), left over from before PR chore(solution): Remove redundant <DocumentationFile> properties and gate PrintSettings target #228 removed the <DocumentationFile> properties. Added an explicit .gitignore entry alongside the existing generated-XML entries.
Untracked seven Rider .idea metadata files under src/Common.Serialization.NewtonsoftJson/.idea/ (git rm --cached — kept on disk). The existing **/.idea*/ ignore rule keeps them out of the index from now on.
Deleted the stale, already-untracked src/Common/Ploch.Common.xml from the working tree.
Design Decisions
The .idea files were untracked but left on disk (IDE metadata may still be in local use); the stale XML doc was fully deleted (generated artefact with no consumer — verified no .csproj/.props references it).
No change-log entry: repo hygiene with no user-visible impact, per the change-log rules.
The artefacts originally named in the issue (src/Common/Ploch.Common.xml,
*.cs.bak files) were already untracked/removed by earlier cleanups, but the
same sweep found two remaining instances of the same problem:
- Ploch.Common.Serialiation.NewtonsoftJson.xml (stale generated XML doc
with a typo in its name, left over from before PR #228 removed the
DocumentationFile properties) - removed and gitignored.
- Seven Rider .idea metadata files tracked under
src/Common.Serialization.NewtonsoftJson/.idea/ - untracked; the existing
**/.idea*/ ignore rule keeps them out from now on.
Also deleted the stale untracked src/Common/Ploch.Common.xml from disk.
No project references any of the removed files; full solution builds with
zero new warnings and all tests pass.
Refs: #234
🧙 Sourcery has finished reviewing your pull request!
Tips and commands
Interacting with Sourcery
Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment @sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment @sourcery-ai review to trigger a new review!
@kploch, you've reached your PR review limit, so we couldn't start this review.
Next review available in:35 minutes
Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).
How can I continue?
After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.
To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.
How do review limits work?
CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.
For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%
AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.
TIP This summary will be updated as you push new changes.
We reviewed changes in 5f324e1...a8ccff5 on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.
AI Review is run only on demand for your team. We're only showing results of static analysis review right now. To trigger AI Review, comment @deepsourcebot review on this thread.
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Removes stale generated artifacts and IDE metadata from source control to keep the repository clean and avoid reintroducing generated/IDE files into commits.
Changes:
Removed a stale generated XML documentation file from src/Common.Serialization.NewtonsoftJson/ and added an explicit .gitignore entry for it.
Untracked Rider .idea metadata files under src/Common.Serialization.NewtonsoftJson/.idea/ by deleting them from the repository.
Kept existing ignore conventions for generated XML docs and IDE metadata.
Reviewed changes
Copilot reviewed 1 out of 9 changed files in this pull request and generated no comments.
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR performs necessary repository maintenance by untracking stale XML documentation and IDE-specific metadata. While the core maintenance tasks are performed, there is a discrepancy between the PR description and the implementation: a fix for the 'WebUI IsPackable' warning (issue #250) is mentioned but not present in the diff. Additionally, the update to the .gitignore includes a typoed filename; while this matches a legacy file being deleted, it may be redundant as the correctly spelled entry already exists.
About this PR
The PR description indicates that a fix for issue #250 (WebUI IsPackable warning) is included in this batch, but the diff contains no changes to project files or configurations that would address this warning. Please verify if the changes were omitted from the commit.
Test suggestions
Verify that the typoed XML file path is correctly ignored by .gitignore
Verify that the solution builds successfully without the removed artifacts
Low confidence findings
The description mentions deleting an already-untracked file (src/Common/Ploch.Common.xml) from the working tree. This action is naturally absent from the git diff and cannot be verified through this PR.
…ore entry
Review follow-up on PR #259: the project file is named
Ploch.Common.Serialiation.NewtonsoftJson.csproj (with the typo), so the
assembly - and therefore any generated XML doc - carries the typo'd name.
The entry added in this PR (typo spelling) is the accurate guard; the
pre-existing correctly-spelled entry never matched any file and is the
one removed as clutter.
Refs: #234
🤖 Review skipped: Repository Owner rate limit exceeded. Free accounts are limited to 3 reviews per 4 hours across all repositories. Upgrade to a paid plan for unlimited reviews.
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
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.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
Summary
Implements #234 — repo hygiene: remove stale generated artefacts and IDE metadata from source control.
The artefacts originally named in the issue (
src/Common/Ploch.Common.xml,tests/**/*.cs.bak) turned out to be already resolved by earlier cleanups (.gitignore:398ignores the XML;*.bakis ignored at line 362 and no.bakfiles remain). This PR completes the issue's intent by sweeping the remaining instances of the same problem class.Changes
src/Common.Serialization.NewtonsoftJson/Ploch.Common.Serialiation.NewtonsoftJson.xml— a stale generated XML documentation file (note the typo in its name), left over from before PR chore(solution): Remove redundant <DocumentationFile> properties and gate PrintSettings target #228 removed the<DocumentationFile>properties. Added an explicit.gitignoreentry alongside the existing generated-XML entries..ideametadata files undersrc/Common.Serialization.NewtonsoftJson/.idea/(git rm --cached— kept on disk). The existing**/.idea*/ignore rule keeps them out of the index from now on.src/Common/Ploch.Common.xmlfrom the working tree.Design Decisions
.ideafiles were untracked but left on disk (IDE metadata may still be in local use); the stale XML doc was fully deleted (generated artefact with no consumer — verified no.csproj/.propsreferences it).Testing
Related
Closes #234
Summary by Sourcery
Remove stale generated artifacts and IDE metadata from source control to improve repository hygiene.
Chores: