Skip to content

docs(pr-template): fix markdown lint warnings and compact template#61

Merged
roottool merged 2 commits intomainfrom
docs/fix-pr-template-markdown-lint
Mar 1, 2026
Merged

docs(pr-template): fix markdown lint warnings and compact template#61
roottool merged 2 commits intomainfrom
docs/fix-pr-template-markdown-lint

Conversation

@roottool
Copy link
Owner

@roottool roottool commented Mar 1, 2026

Changes

  • Fix MD036 and MD040 markdown lint warnings
  • Compact PR template from 79 lines to 36 lines
    • Remove blockquote explanation from Boundary Checklist
    • Flatten Security & API Stability subsections (remove ### level)
    • Flatten Testing subsections and simplify manual testing note
    • Remove Automated Review section entirely

Motivation

The PR template had grown too large (79 lines) for a small library. The lint
warnings (MD036: emphasis used instead of heading, MD040: fenced code
blocks without language) were also present. This PR fixes the warnings and
takes the opportunity to streamline the template to a more maintainable size.

Related

  • No related issues

Signature

🤖 Generated with Claude Code

Co-Authored-By: Claude noreply@anthropic.com

roottool and others added 2 commits March 2, 2026 03:17
Replace bold emphasis used as subheadings with proper ### headings
in the Security & API Stability and Testing sections (MD036).
Add text language specifier to the fenced code block in the
Automated Review section (MD040).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Remove blockquote explanation from Boundary Checklist
- Flatten Security & API Stability subsections
- Flatten Testing subsections and simplify manual testing note
- Remove Automated Review section entirely

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@roottool roottool self-assigned this Mar 1, 2026
@roottool roottool added documentation Improvements or additions to documentation ignore for release Exclude from release notes labels Mar 1, 2026
@roottool roottool merged commit d0286a7 into main Mar 1, 2026
11 checks passed
@roottool roottool deleted the docs/fix-pr-template-markdown-lint branch March 1, 2026 18:26
@codecov
Copy link

codecov bot commented Mar 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (ba01474) to head (f041205).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #61   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           23        23           
  Branches         5         5           
=========================================
  Hits            23        23           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ignore for release Exclude from release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant