Improve markdown and changelog instructions for clarity and consistency#2146
Improve markdown and changelog instructions for clarity and consistency#2146johlju merged 9 commits intodsccommunity:mainfrom
Conversation
WalkthroughUpdated multiple DSC community instruction files and the changelog: refined changelog wording, tightened Markdown and formatting rules, added text-formatting conventions, adjusted Pester and PowerShell guidance. No code, tests, or public API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (2)
🧰 Additional context used🧠 Learnings (8)📓 Common learnings📚 Learning: 2025-08-17T09:48:55.756ZApplied to files:
📚 Learning: 2025-08-17T09:48:55.756ZApplied to files:
📚 Learning: 2025-08-17T09:48:55.756ZApplied to files:
📚 Learning: 2025-08-17T09:48:55.756ZApplied to files:
📚 Learning: 2025-08-17T09:48:55.756ZApplied to files:
📚 Learning: 2025-08-17T09:48:55.756ZApplied to files:
📚 Learning: 2025-08-17T09:48:55.756ZApplied to files:
🪛 LanguageTool.github/instructions/dsc-community-style-guidelines-pester.instructions.md[grammar] ~50-~50: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~50-~50: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~51-~51: There might be a mistake here. (QB_NEW_EN_OTHER) .github/instructions/dsc-community-style-guidelines-markdown.instructions.md[grammar] ~12-~12: Use modal and auxiliary verbs correctly (QB_NEW_EN_OTHER_ERROR_IDS_24) [grammar] ~12-~12: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~13-~13: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~15-~15: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~17-~17: There might be a mistake here. (QB_NEW_EN) [grammar] ~18-~18: There might be a mistake here. (QB_NEW_EN) [grammar] ~19-~19: There might be a mistake here. (QB_NEW_EN) [grammar] ~20-~20: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) 🪛 markdownlint-cli2 (0.17.2).github/instructions/dsc-community-style-guidelines-markdown.instructions.md18-18: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 19-19: Lists should be surrounded by blank lines (MD032, blanks-around-lists) ⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (17)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
💡 Knowledge Base configuration:
- Jira integration is disabled
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
.github/instructions/dsc-community-style-guidelines-changelog.instructions.md(1 hunks).github/instructions/dsc-community-style-guidelines-markdown.instructions.md(1 hunks)CHANGELOG.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
CHANGELOG.md
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Always update the Unreleased section in CHANGELOG.md using Keep a Changelog format with concrete release notes for changes (new/modified commands, functions, resources)
Files:
CHANGELOG.md
⚙️ CodeRabbit configuration file
CHANGELOG.md: # Changelog Guidelines
- Always update the Unreleased section in CHANGELOG.md
- Use Keep a Changelog format
- Describe main changes as concise release notes
- Reference issues using format #<issue_number>
- No empty lines between list items in same section
- Do not add item if there are already an existing item for the same change
Files:
CHANGELOG.md
**/*.md
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Markdown: wrap lines at word boundaries when exceeding 80 characters; use 2 spaces for indentation
Files:
CHANGELOG.md
⚙️ CodeRabbit configuration file
**/*.md: # Markdown Style Guidelines
- Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
- Use 2 spaces for indentation
- Use '1.' for all items in ordered lists (1/1/1 numbering style)
- Surround fenced code blocks with blank lines
- Disable
MD013rule by adding a comment for tables/code blocks exceeding 80 characters
Files:
CHANGELOG.md
**
⚙️ CodeRabbit configuration file
**: # DSC Community GuidelinesTerminology
- Command: Public command
- Function: Private function
- Resource: DSC class-based resource
Build & Test Workflow
- Run project scripts in PowerShell from repository root
- Build after source changes:
.\build.ps1 -Tasks build- Test workflow: Build →
Invoke-Pester -Path @('<test paths>') -Output Detailed- New session required after class changes
File Organization
- Public commands:
source/Public/{CommandName}.ps1- Private functions:
source/Private/{FunctionName}.ps1- Unit tests:
tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1- Integration tests:
tests/Integration/Commands/{CommandName}.Integration.Tests.ps1Requirements
- Always update CHANGELOG.md Unreleased section
- Localize all strings using string keys
- Check DscResource.Common before creating private functions
- Separate reusable logic into private functions
- Add unit tests for all commands/functions/resources
- Add integration tests for all public commands and resources
Files:
CHANGELOG.md
🧠 Learnings (3)
📓 Common learnings
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to CHANGELOG.md : Always update the Unreleased section in CHANGELOG.md using Keep a Changelog format with concrete release notes for changes (new/modified commands, functions, resources)
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to CHANGELOG.md : Always update the Unreleased section in CHANGELOG.md using Keep a Changelog format with concrete release notes for changes (new/modified commands, functions, resources)
Applied to files:
CHANGELOG.md.github/instructions/dsc-community-style-guidelines-changelog.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to **/*.ps1 : Use <# ... #> for multiline comments; indent the multiline text 4 spaces
Applied to files:
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md
🪛 LanguageTool
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md
[grammar] ~13-~13: There might be a mistake here.
Context: ...ure empty line before and after headings - Escape backslashes in file paths only (n...
(QB_NEW_EN_OTHER)
[grammar] ~15-~15: There might be a mistake here.
Context: ... file paths only (not in code blocks) - Ensure empty line before and after code blocks...
(QB_NEW_EN)
[grammar] ~15-~15: There might be a mistake here.
Context: ... empty line before and after code blocks - Code blocks must specify language identi...
(QB_NEW_EN_OTHER)
[grammar] ~16-~16: There might be a mistake here.
Context: ...blocks must specify language identifiers ## Text Formatting - Parameters: bold ...
(QB_NEW_EN_OTHER)
[grammar] ~18-~18: Use correct spacing
Context: ...language identifiers ## Text Formatting - Parameters: bold - Values/literals: ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~20-~20: There might be a mistake here.
Context: ...## Text Formatting - Parameters: bold - Values/literals: inline code - Resourc...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...Parameters: bold - Values/literals: inline code - Resource/module/product names: italic ...
(QB_NEW_EN)
[grammar] ~22-~22: There might be a mistake here.
Context: ...- Resource/module/product names: italic - Commands/files/paths: inline code
(QB_NEW_EN)
[grammar] ~23-~23: Use correct spacing
Context: ...names: italic - Commands/files/paths: inline code
(QB_NEW_EN_OTHER_ERROR_IDS_5)
.github/instructions/dsc-community-style-guidelines-changelog.instructions.md
[grammar] ~11-~11: There might be a mistake here.
Context: ...tems per change type - Reference issues using format [#<issue_number>](https://github...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...nce issues using format #<issue_number> - No empty lines between list items in sam...
(QB_NEW_EN_OTHER)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
- GitHub Check: PSScriptAnalyzer
- GitHub Check: PSScriptAnalyzer
🔇 Additional comments (3)
CHANGELOG.md (1)
91-91: Changelog entry placement and style look correct.The new Unreleased item is under the “Changed” section, concise, and follows the Keep a Changelog structure. No duplicates detected within the section.
.github/instructions/dsc-community-style-guidelines-changelog.instructions.md (1)
10-11: No conflicting guidelines found; linked issue format and concise item guidance stand as-written.After reviewing .github/instructions/dsc-community-style-guidelines-changelog.instructions.md, this file is the sole source of truth for CHANGELOG.md conventions. There are no other repository documents mandating plain “#<issue_number>” references—using Markdown links here ensures clickable issue numbers. The “≤2 items per change type” note encourages brevity without being enforced by tooling. Please disregard the prior recommendation to revert these guidelines; they are intentional and consistent.
Likely an incorrect or invalid review comment.
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md (1)
18-23: Nice addition: “Text Formatting” improves consistency.Clear, actionable conventions for parameters, values, names, and paths. This should reduce mixed styling in docs.
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md (1)
17-22: Clarify path/backslash escaping to align with “Text Formatting”.Since commands/files/paths must be inline code, backslashes should not be escaped. If paths must appear in plain text (rare), then escape them. This avoids contradictions with any legacy guidance.
## Text Formatting - Parameters: **bold** - Values/literals: `inline code` - Resource/module/product names: _italic_ - Commands/files/paths: `inline code` + - For Windows paths, do not escape backslashes when formatted as code. + If inline code cannot be used in rare prose-only contexts, escape backslashes.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
💡 Knowledge Base configuration:
- Jira integration is disabled
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md(1 hunks)CHANGELOG.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
CHANGELOG.md
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Always update the Unreleased section in CHANGELOG.md using Keep a Changelog format with concrete release notes for changes (new/modified commands, functions, resources)
Files:
CHANGELOG.md
⚙️ CodeRabbit configuration file
CHANGELOG.md: # Changelog Guidelines
- Always update the Unreleased section in CHANGELOG.md
- Use Keep a Changelog format
- Describe main changes as concise release notes
- Reference issues using format #<issue_number>
- No empty lines between list items in same section
- Do not add item if there are already an existing item for the same change
Files:
CHANGELOG.md
**/*.md
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Markdown: wrap lines at word boundaries when exceeding 80 characters; use 2 spaces for indentation
Files:
CHANGELOG.md
⚙️ CodeRabbit configuration file
**/*.md: # Markdown Style Guidelines
- Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
- Use 2 spaces for indentation
- Use '1.' for all items in ordered lists (1/1/1 numbering style)
- Surround fenced code blocks with blank lines
- Disable
MD013rule by adding a comment for tables/code blocks exceeding 80 characters
Files:
CHANGELOG.md
**
⚙️ CodeRabbit configuration file
**: # DSC Community GuidelinesTerminology
- Command: Public command
- Function: Private function
- Resource: DSC class-based resource
Build & Test Workflow
- Run project scripts in PowerShell from repository root
- Build after source changes:
.\build.ps1 -Tasks build- Test workflow: Build →
Invoke-Pester -Path @('<test paths>') -Output Detailed- New session required after class changes
File Organization
- Public commands:
source/Public/{CommandName}.ps1- Private functions:
source/Private/{FunctionName}.ps1- Unit tests:
tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1- Integration tests:
tests/Integration/Commands/{CommandName}.Integration.Tests.ps1Requirements
- Always update CHANGELOG.md Unreleased section
- Localize all strings using string keys
- Check DscResource.Common before creating private functions
- Separate reusable logic into private functions
- Add unit tests for all commands/functions/resources
- Add integration tests for all public commands and resources
Files:
CHANGELOG.md
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to CHANGELOG.md : Always update the Unreleased section in CHANGELOG.md using Keep a Changelog format with concrete release notes for changes (new/modified commands, functions, resources)
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to CHANGELOG.md : Always update the Unreleased section in CHANGELOG.md using Keep a Changelog format with concrete release notes for changes (new/modified commands, functions, resources)
Applied to files:
CHANGELOG.md
🪛 LanguageTool
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md
[grammar] ~13-~13: There might be a problem here.
Context: ...ure empty line before and after headings - Ensure empty line before and after code blocks...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~14-~14: There might be a mistake here.
Context: ... empty line before and after code blocks - Code blocks must specify language identi...
(QB_NEW_EN_OTHER)
[grammar] ~15-~15: There might be a mistake here.
Context: ...blocks must specify language identifiers ## Text Formatting - Parameters: bold ...
(QB_NEW_EN_OTHER)
[grammar] ~17-~17: Use correct spacing
Context: ...language identifiers ## Text Formatting - Parameters: bold - Values/literals: ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~19-~19: There might be a mistake here.
Context: ...## Text Formatting - Parameters: bold - Values/literals: inline code - Resourc...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...Parameters: bold - Values/literals: inline code - Resource/module/product names: italic ...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...- Resource/module/product names: italic - Commands/files/paths: inline code
(QB_NEW_EN)
[grammar] ~22-~22: Use correct spacing
Context: ...names: italic - Commands/files/paths: inline code
(QB_NEW_EN_OTHER_ERROR_IDS_5)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
- GitHub Check: PSScriptAnalyzer
🔇 Additional comments (2)
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md (2)
13-15: LGTM: New spacing and language-identifier rules are clear and align with house style.The additions for heading/code-block spacing and mandatory language identifiers improve consistency across docs.
13-22: Confirmed no conflicting rules remain in instructionsI’ve scanned all
.mdfiles under.github/instructionsfor:
- Legacy guidance on escaping backslashes or file-path escaping
- Duplicate or divergent code-block spacing rules
No matches were found outside
dsc-community-style-guidelines-markdown.instructions.md, so there are no conflicting or outdated directives left. Everything is harmonized.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2146 +/- ##
====================================
Coverage 94% 94%
====================================
Files 110 110
Lines 8171 8171
====================================
Hits 7732 7732
Misses 439 439
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
💡 Knowledge Base configuration:
- Jira integration is disabled
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
.github/instructions/dsc-community-style-guidelines-pester.instructions.md(1 hunks).github/instructions/dsc-community-style-guidelines-powershell.instructions.md(2 hunks)
🧰 Additional context used
🧠 Learnings (10)
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to tests/**/*.ps1 : Use BeforeAll/BeforeEach/AfterAll/AfterEach inside Context, placed near the It blocks using them; duplication across contexts is acceptable; AfterAll can clean up; use BeforeEach/AfterEach sparingly
Applied to files:
.github/instructions/dsc-community-style-guidelines-pester.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to tests/**/*.ps1 : Each scenario/path should be in Context blocks starting with 'When'; It block descriptions should start with 'Should' and must call the subject; results and assertions stay within the same It; BeforeAll/BeforeEach must not call the subject
Applied to files:
.github/instructions/dsc-community-style-guidelines-pester.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to tests/**/*.ps1 : Test code must not exist outside of a Describe block
Applied to files:
.github/instructions/dsc-community-style-guidelines-pester.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to **/*.ps1 : Use splatting to reduce line length
Applied to files:
.github/instructions/dsc-community-style-guidelines-powershell.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to source/Classes/*.ps1 : Derived DSC resource classes must use [DscResource(RunAsCredential = 'Optional')]
Applied to files:
.github/instructions/dsc-community-style-guidelines-powershell.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to **/*.ps1 : Use camelCase for local variable names
Applied to files:
.github/instructions/dsc-community-style-guidelines-powershell.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to source/{Public,Private,Classes}/*.ps1 : Use PascalCase for function names and parameters in public commands, private functions, and class-based resources
Applied to files:
.github/instructions/dsc-community-style-guidelines-powershell.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to **/*.ps1 : Use descriptive, clear, full names for variables, parameters, and function names; names must be more than 2 characters; no abbreviations
Applied to files:
.github/instructions/dsc-community-style-guidelines-powershell.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to **/*.ps1 : PowerShell reserved keywords should be lowercase
Applied to files:
.github/instructions/dsc-community-style-guidelines-powershell.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to **/*.ps1 : PowerShell files must be UTF-8 without BOM and end with a newline
Applied to files:
.github/instructions/dsc-community-style-guidelines-powershell.instructions.md
🪛 LanguageTool
.github/instructions/dsc-community-style-guidelines-pester.instructions.md
[grammar] ~50-~50: There might be a mistake here.
Context: ...sparingly - Avoid try-catch blocks in tests, use AfterAllorAfterEach` for clea...
(QB_NEW_EN_OTHER)
[grammar] ~50-~50: Use correct spacing
Context: ... - Avoid try-catch blocks in tests, use AfterAll or AfterEach for cleanup - ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~50-~50: There might be a mistake here.
Context: ...e AfterAll or AfterEach for cleanup - Avoid unnecessary remove/recreate cycles...
(QB_NEW_EN_OTHER)
.github/instructions/dsc-community-style-guidelines-powershell.instructions.md
[grammar] ~168-~168: There might be a mistake here.
Context: ...ile Rules - End files with a blank line - Use CR+LF line endings - Maximum two con...
(QB_NEW_EN_OTHER)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
- GitHub Check: PSScriptAnalyzer
- GitHub Check: PSScriptAnalyzer
…-catch blocks in tests
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (2)
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md (2)
21-21: Resolve backslash-escaping ambiguity for paths (follow-up to earlier comment)This clarifies that inline-code paths shouldn’t escape backslashes, while allowing escapes only when inline code cannot be used.
- - Commands/files/paths: `inline code` + - Commands/files/paths: `inline code` + - When paths are formatted as inline code, do not escape backslashes. If inline code cannot be used (rare), escape backslashes in plain text.
16-21: Add compact Do/Don’t examples to reduce ambiguityA quick example block here will cut back-and-forth in reviews and aligns with the team learning to wrap lines and keep consistent formatting.
## Text Formatting @@ - Parameters: **bold** - Values/literals: `inline code` - Resource/module/product names: _italic_ - Commands/files/paths: `inline code` + +### Examples + +Do: +- Use **InstanceName** with value `MSSQLSERVER`; refer to _SqlSetup_ and command `Install-DscResource`. +- Wrap paths as inline code: `C:\Program Files\Microsoft SQL Server`. +- Fence code with language: + ```powershell + Get-Module SqlServerDsc + ``` + +Don’t: +- Mix styles (e.g., italicizing literals or leaving code fences untyped). +- Omit the blank line before/after fences or headings.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
💡 Knowledge Base configuration:
- Jira integration is disabled
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to source/{Public,Private,Classes}/*.ps1 : In comment-based help, each keyword must be indented 4 spaces and its text indented 8 spaces
Applied to files:
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to **/*.md : Markdown: wrap lines at word boundaries when exceeding 80 characters; use 2 spaces for indentation
Applied to files:
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md
📚 Learning: 2025-08-17T09:48:55.756Z
Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-17T09:48:55.756Z
Learning: Applies to **/*.ps1 : Use <# ... #> for multiline comments; indent the multiline text 4 spaces
Applied to files:
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md
🪛 LanguageTool
.github/instructions/dsc-community-style-guidelines-markdown.instructions.md
[grammar] ~12-~12: There might be a mistake here.
Context: ...s/code blocks exceeding 80 characters - Ensure empty line before and after headings - ...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a problem here.
Context: ...ure empty line before and after headings - Ensure empty line before and after code blocks...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~13-~13: There might be a mistake here.
Context: ... empty line before and after code blocks - Code blocks must specify language identi...
(QB_NEW_EN_OTHER)
[grammar] ~14-~14: There might be a mistake here.
Context: ...blocks must specify language identifiers ## Text Formatting - Parameters: bold ...
(QB_NEW_EN_OTHER)
[grammar] ~16-~16: Use correct spacing
Context: ...language identifiers ## Text Formatting - Parameters: bold - Values/literals: ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~18-~18: There might be a mistake here.
Context: ...## Text Formatting - Parameters: bold - Values/literals: inline code - Resourc...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...Parameters: bold - Values/literals: inline code - Resource/module/product names: italic ...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...- Resource/module/product names: italic - Commands/files/paths: inline code
(QB_NEW_EN)
[grammar] ~21-~21: Use correct spacing
Context: ...names: italic - Commands/files/paths: inline code
(QB_NEW_EN_OTHER_ERROR_IDS_5)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
- GitHub Check: PSScriptAnalyzer
…arkdown guidelines
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
1 participant
Pull Request (PR) description
This Pull Request (PR) fixes the following issues
Task list
file CHANGELOG.md. Entry should say what was changed and how that
affects users (if applicable), and reference the issue being resolved
(if applicable).
This change is