File tree Expand file tree Collapse file tree 3 files changed +14
-2
lines changed
Expand file tree Collapse file tree 3 files changed +14
-2
lines changed Original file line number Diff line number Diff line change @@ -7,7 +7,7 @@ applyTo: "CHANGELOG.md"
77
88- Always update the Unreleased section in CHANGELOG.md
99- Use Keep a Changelog format
10- - Describe main changes as concise release notes
11- - Reference issues using format #<issue_number>
10+ - Describe notable changes briefly, ≤2 items per change type
11+ - Reference issues using format [ #<issue_number>] ( https://github.com/<owner>/<repo>/issues/<issue_number> )
1212- No empty lines between list items in same section
1313- Do not add item if there are already an existing item for the same change
Original file line number Diff line number Diff line change @@ -10,3 +10,14 @@ applyTo: "**/*.md"
1010- Use '1.' for all items in ordered lists (1/1/1 numbering style)
1111- Surround fenced code blocks with blank lines
1212- Disable ` MD013 ` rule by adding a comment for tables/code blocks exceeding 80 characters
13+ - Ensure empty line before and after headings
14+ - Escape backslashes in file paths only (not in code blocks)
15+ - Ensure empty line before and after code blocks
16+ - Code blocks must specify language identifiers
17+
18+ ## Text Formatting
19+
20+ - Parameters: ** bold**
21+ - Values/literals: ` inline code `
22+ - Resource/module/product names: _ italic_
23+ - Commands/files/paths: ` inline code `
Original file line number Diff line number Diff line change @@ -88,6 +88,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8888 - Improved documentation with optimized analysis workflow description.
8989- DSC community style guidelines
9090 - Added requirement to follow guidelines over existing code patterns.
91+ - Improved markdown and changelog instructions.
9192
9293## [ 17.1.0] - 2025-05-22
9394
You can’t perform that action at this time.
0 commit comments