Allowing to skip tests with 'SuppressMessageAttribute'#178
Allowing to skip tests with 'SuppressMessageAttribute'#178gaelcolas merged 3 commits intodsccommunity:mainfrom
Conversation
WalkthroughDocumentation and test metadata updates: added guidance for AllowSuppressMessageAttribute in CHANGELOG.md and README.md, and added the Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@CHANGELOG.md`:
- Around line 10-12: Change the changelog section header from "### Fixes" to
"### Fixed", update the issue link to the format "[issue
`#135`](https://github.com/dsccommunity/DscResource.Test/issues/135)", and reflow
the bullet text about adding tag `AllowSuppressMessageAttribute` to the test
"Should not suppress the required rule" so no line exceeds 80 characters; ensure
the updated bullet reads clearly and is wrapped into multiple lines under the
corrected "### Fixed" header.
In `@README.md`:
- Around line 1177-1206: Wrap the prose in the "Skipping tests that validate
SuppressMessageAttribute usage" section so no line exceeds 80 characters;
specifically reflow the paragraph that starts with "The test `Should not
suppress the required rule` validates..." and the subsequent example blocks and
paragraphs (including the `AllowSuppressMessageAttribute` tag mentions and both
example code blocks) to lines ≤80 characters while preserving Markdown structure
and inline code/backticks.
| ### Fixes | ||
|
|
||
| - Added tag `AllowSuppressMessageAttribute` to test `Should not suppress the required rule` to allow usage of `SuppressMessageAttribute` [#135](https://github.com/dsccommunity/DscResource.Test/issues/135). |
There was a problem hiding this comment.
Align changelog section name and issue link format; wrap line length.
Use ### Fixed (Keep a Changelog), format issue links as [issue #135](...), and wrap the long line to ≤80 chars.
📄 Proposed fix
-### Fixes
+### Fixed
-- Added tag `AllowSuppressMessageAttribute` to test `Should not suppress the required rule` to allow usage of `SuppressMessageAttribute` [`#135`](https://github.com/dsccommunity/DscResource.Test/issues/135).
+- Added tag `AllowSuppressMessageAttribute` to test `Should not suppress the
+ required rule` to allow usage of `SuppressMessageAttribute`
+ [issue `#135`](https://github.com/dsccommunity/DscResource.Test/issues/135).As per coding guidelines, …
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Fixes | |
| - Added tag `AllowSuppressMessageAttribute` to test `Should not suppress the required rule` to allow usage of `SuppressMessageAttribute` [#135](https://github.com/dsccommunity/DscResource.Test/issues/135). | |
| ### Fixed | |
| - Added tag `AllowSuppressMessageAttribute` to test `Should not suppress the | |
| required rule` to allow usage of `SuppressMessageAttribute` | |
| [issue `#135`](https://github.com/dsccommunity/DscResource.Test/issues/135). |
🤖 Prompt for AI Agents
In `@CHANGELOG.md` around lines 10 - 12, Change the changelog section header from
"### Fixes" to "### Fixed", update the issue link to the format "[issue
`#135`](https://github.com/dsccommunity/DscResource.Test/issues/135)", and reflow
the bullet text about adding tag `AllowSuppressMessageAttribute` to the test
"Should not suppress the required rule" so no line exceeds 80 characters; ensure
the updated bullet reads clearly and is wrapped into multiple lines under the
corrected "### Fixed" header.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #178 +/- ##
===================================
Coverage 79% 79%
===================================
Files 43 43
Lines 569 569
===================================
Hits 452 452
Misses 117 117 🚀 New features to boost your workflow:
|
|
|
||
| ## [Unreleased] | ||
|
|
||
| ### Fixes |
There was a problem hiding this comment.
Fixed is the correct term in Keepachangelog format.
Pull Request (PR) description
Added tag
AllowSuppressMessageAttributeto testShould not suppress the required ruleto allow usage ofSuppressMessageAttribute#135.This Pull Request (PR) fixes the following issues
Task list
Entry should say what was changed and how that affects users (if applicable), and
reference the issue being resolved (if applicable).
This change is