Skip to content

Commit 0a54f3f

Browse files
Copilotpelikhan
Copilot
and
pelikhan
committed
Merge branch 'main' into copilot/fix-safe-outputs-import-gaps
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
1 parent faabc1e commit 0a54f3f

28 files changed

Lines changed: 131 additions & 63 deletions

‎.github/workflows/cli-consistency-checker.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,41 +158,44 @@ When issues are found, create a **single consolidated issue** that includes:
158158
- Suggested fix if applicable
159159
- Priority level: `high` (breaks functionality), `medium` (confusing/misleading), `low` (minor inconsistency)
160160

161+
**Report Formatting**: Use h3 (###) or lower for all headers in the report. Wrap long sections (>5 findings) in `<details><summary><b>Section Name</b></summary>` tags to improve readability. The issue title serves as h1, so start section headers at h3.
162+
161163
### Issue Format
162164

163165
```markdown
164-
## Summary
166+
### Summary
165167

166168
Automated CLI consistency inspection found **X inconsistencies** in command help text that should be addressed for better user experience and documentation clarity.
167169

168-
### Breakdown by Severity
170+
#### Breakdown by Severity
169171

170172
- **High**: X (Breaks functionality)
171173
- **Medium**: X (Inconsistent terminology)
172174
- **Low**: X (Minor inconsistencies)
173175

174-
### Issue Categories
176+
#### Issue Categories
175177

176178
1. **[Category Name]** (X commands)
177179
- Brief description of the pattern
178180
- Affects: `command1`, `command2`, etc.
179181

180-
### Inspection Details
182+
#### Inspection Details
181183

182184
- **Total Commands Inspected**: XX
183185
- **Commands with Issues**: X
184186
- **Date**: [Date]
185187
- **Method**: Executed all CLI commands with `--help` flags and analyzed actual output
186188

187-
### Findings Summary
189+
#### Findings Summary
188190

189191
✅ **No issues found** in these areas:
190192
- [List areas that passed inspection]
191193

192194
⚠️ **Issues found**:
193195
- [List areas with issues]
194196

195-
### Detailed Findings
197+
<details>
198+
<summary><b>Detailed Findings</b></summary>
196199

197200
#### 1. [Issue Title]
198201

@@ -213,6 +216,8 @@ Automated CLI consistency inspection found **X inconsistencies** in command help
213216
214217
[Repeat for each finding]
215218
219+
</details>
220+
216221
```
217222

218223
**Important Notes**:

‎.github/workflows/daily-news.lock.yml‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/docs-noob-tester.lock.yml‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/github-mcp-tools-report.lock.yml‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/jsweep.lock.yml‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/mcp-inspector.lock.yml‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/repository-quality-improver.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -294,22 +294,24 @@ Create a comprehensive report using the **reporting MCP** with the following str
294294

295295
### Report Template
296296

297+
**Report Formatting**: Use h3 (###) or lower for all headers in the report to maintain proper document hierarchy. The discussion title serves as h1, so start section headers at h3.
298+
297299
```markdown
298-
# 🎯 Repository Quality Improvement Report - [FOCUS AREA]
300+
### 🎯 Repository Quality Improvement Report - [FOCUS AREA]
299301

300302
**Analysis Date**: [DATE]
301303
**Focus Area**: [SELECTED AREA]
302304
**Strategy Type**: [Custom/Standard/Reused]
303305
**Custom Area**: [Yes/No - If yes, explain the rationale for this specific focus]
304306

305-
## Executive Summary
307+
### Executive Summary
306308

307309
[2-3 paragraphs summarizing the analysis findings and key recommendations]
308310

309311
<details>
310312
<summary><b>Full Analysis Report</b></summary>
311313

312-
## Focus Area: [AREA NAME]
314+
### Focus Area: [AREA NAME]
313315

314316
### Current State Assessment
315317

‎.github/workflows/research.lock.yml‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)