Skip to content

fix: resolve all markdown lint violations and enable enforced rules#24

Merged
don-petry merged 2 commits intomainfrom
fix/markdown-lint-violations
Apr 5, 2026
Merged

fix: resolve all markdown lint violations and enable enforced rules#24
don-petry merged 2 commits intomainfrom
fix/markdown-lint-violations

Conversation

@don-petry
Copy link
Copy Markdown
Contributor

@don-petry don-petry commented Apr 5, 2026

Summary

Fixes all 54 markdownlint violations and enables previously-disabled rules so they are enforced going forward.

Rules Enabled

Rule What it enforces Config
MD013 Line length <= 200 chars Tables and code blocks excluded
MD024 No duplicate headings Siblings only (same parent)
MD032 Blank lines around lists
MD034 No bare URLs Must use <url> or [text](url)

Fixes Applied

  • AGENTS.md (51 fixes): Wrapped 44 long lines at sentence boundaries, added 6 blank lines around lists, wrapped 3 bare URLs
  • standards/ci-standards.md (1 fix): Blank line before list
  • standards/dependabot-policy.md (1 fix): Blank line before list
  • .markdownlint-cli2.yaml: Enabled rules, added .claude/ and node_modules/ to ignore list

Test plan

  • npx markdownlint-cli2 "**/*.md" — 0 errors locally
  • CI Lint job passes

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Improved readability and formatting across contributor guides and CI docs
    • Expanded CI automation guidance with new issue-trigger behavior and label/permission requirements
  • Chores

    • Updated Markdown linting rules and defaults for line length, lists, headings, URLs, and table style
    • Small formatting cleanups to policy docs

Enable previously-disabled markdownlint rules:
- MD013 (line length 200, excluding tables/code blocks)
- MD024 (duplicate headings, siblings only)
- MD032 (blanks around lists)
- MD034 (no bare URLs)

Fix 54 violations across 3 files:
- AGENTS.md: wrap 44 long lines, add 6 blank lines around lists,
  wrap 3 bare URLs in angle brackets
- standards/ci-standards.md: 1 blank line around list
- standards/dependabot-policy.md: 1 blank line around list

Also add .claude/ and node_modules/ to markdownlint ignore list.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 5, 2026 19:34
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 5, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: e6feb728-3c51-44dc-b179-38091b8daa5d

📥 Commits

Reviewing files that changed from the base of the PR and between 55dd8d8 and acd0c79.

📒 Files selected for processing (2)
  • AGENTS.md
  • standards/ci-standards.md

📝 Walkthrough

Walkthrough

Updates markdown-lint rules and top-level ignores, reflows AGENTS.md text, and extends the Claude Code CI guidance to allow issue-labeled triggers with elevated job permissions and a pinned action version. Also adds a minor spacing edit to dependabot policy.

Changes

Cohort / File(s) Summary
Markdown Linting Configuration
.markdownlint-cli2.yaml
Added ignores for .claude/** and node_modules/**. Converted MD013 to a rule with line_length: 200 (excluding tables/code), enabled MD032, changed MD024 to siblings_only: true, set MD034: true (disallow bare URLs), added MD060: false, retained MD033: false and MD041: true.
Agent & Docs Reflow
AGENTS.md
Reflowed paragraphs and lists (whitespace/line-wrapping, indentation adjustments) and reformatted some inline links to angle-bracket form; no semantic/content changes.
Claude CI Workflow
standards/ci-standards.md
Documented adding issues: labeled trigger and if for claude label, changed job permissions to include contents: write, pinned anthropics/claude-code-action to a specific v1.0.89 SHA, added label_trigger: "claude", and documented label requirements and issue-trigger security.
Dependabot Docs
standards/dependabot-policy.md
Inserted a blank line under “Behavior:” in the Auto-Merge Workflow section (formatting-only).

Sequence Diagram(s)

mermaid
sequenceDiagram
participant User as User
participant GitHub as GitHub Issues
participant Actions as GitHub Actions
participant ClaudeAction as anthropics/claude-code-action
participant Repo as Repository
User->>GitHub: add claude label to issue
GitHub->>Actions: trigger workflow (issues:labeled)
Actions->>ClaudeAction: run pinned action (label_trigger: "claude")
ClaudeAction->>Repo: create branch/commit/PR (requires contents: write)
Actions->>User: report workflow result

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly describes the main change: resolving markdown lint violations and enabling enforced rules, which aligns with the file modifications and PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/markdown-lint-violations

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@standards/ci-standards.md`:
- Line 165: The inline version comment for the GitHub Action reference
"anthropics/claude-code-action@6e2bd52842c65e914eba5c8badd17560bd26b5de" should
be updated to the floating tag per standards; change the trailing comment from
"# v1.0.89" to "# v1" so the action remains pinned by SHA while the comment
references the floating v1 tag.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5d2f6ade-7cd9-4638-a59e-4dd08a0c2c21

📥 Commits

Reviewing files that changed from the base of the PR and between 1f9db97 and 55dd8d8.

📒 Files selected for processing (4)
  • .markdownlint-cli2.yaml
  • AGENTS.md
  • standards/ci-standards.md
  • standards/dependabot-policy.md

Comment thread standards/ci-standards.md
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aims to eliminate existing Markdown lint violations across the organization standards docs and update markdownlint configuration so key rules are enforced going forward.

Changes:

  • Reformats Markdown in AGENTS.md and standards docs to address lint rules (line length, blank lines around lists, bare URLs).
  • Updates standards/ci-standards.md content around the Claude Code workflow configuration and target action version.
  • Enables/enforces markdownlint rules in .markdownlint-cli2.yaml and expands ignore patterns.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 12 comments.

File Description
AGENTS.md Wrapped long lines / URL formatting updates; however, several list items appear to have broken Markdown structure due to missing continuation indentation.
standards/ci-standards.md Adds/updates Claude workflow guidance and permissions; currently appears inconsistent with the repo’s implemented .github/workflows/claude.yml and audit script behavior.
standards/dependabot-policy.md Adds required blank line before a list to satisfy list-spacing rules.
.markdownlint-cli2.yaml Enables MD013/MD024/MD032/MD034 (and other config tweaks) and adds ignore patterns.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread standards/ci-standards.md
Comment thread standards/ci-standards.md
Comment thread standards/ci-standards.md
Comment thread standards/ci-standards.md Outdated
Comment thread standards/ci-standards.md
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
- Fix 7 locations in AGENTS.md where wrapped list items had
  unindented continuation lines (breaks Markdown rendering)
- Fix ci-standards.md issue trigger security note: triage role
  can also label, and compliance audit uses its own label

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Apr 5, 2026

@don-petry don-petry merged commit 788df7d into main Apr 5, 2026
44 checks passed
don-petry added a commit to petry-projects/broodly that referenced this pull request Apr 5, 2026
Add issues:[labeled] event trigger and claude label support so Claude
can work issues like a human contributor — reading the issue, creating
a branch, implementing the fix, and opening a PR.

Changes:
- Add issues:[labeled] trigger to on: block
- Add issue label condition to job if: guard
- Upgrade contents permission to write (needed for branch creation)
- Pin claude-code-action to v1.0.89 (6e2bd528)
- Add label_trigger: "claude" input

Matches the standard configuration defined in
petry-projects/.github#24 (standards/ci-standards.md § Claude Code).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
don-petry added a commit to petry-projects/broodly that referenced this pull request Apr 5, 2026
* chore: enable Claude issue trigger per org CI standard

Add issues:[labeled] event trigger and claude label support so Claude
can work issues like a human contributor — reading the issue, creating
a branch, implementing the fix, and opening a PR.

Changes:
- Add issues:[labeled] trigger to on: block
- Add issue label condition to job if: guard
- Upgrade contents permission to write (needed for branch creation)
- Pin claude-code-action to v1.0.89 (6e2bd528)
- Add label_trigger: "claude" input

Matches the standard configuration defined in
petry-projects/.github#24 (standards/ci-standards.md § Claude Code).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* chore: add permission comment per CodeRabbit review

Document why contents: write is needed (issue-triggered branch creation).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
don-petry pushed a commit to petry-projects/google-app-scripts that referenced this pull request Apr 5, 2026
Add issues:[labeled] event trigger and claude label support so Claude
can work issues autonomously — reading the issue, creating a branch,
implementing the fix, and opening a PR.

Changes:
- Add issues:[labeled] trigger to on: block
- Add issue label condition to job if: guard
- Upgrade contents permission to write (needed for branch creation)
- Pin claude-code-action to v1.0.89 (6e2bd528)
- Add label_trigger: "claude" input
- Add dependabot skip condition on step
- Add permission comment for contents: write

Matches the standard defined in petry-projects/.github#24.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
don-petry pushed a commit to petry-projects/ContentTwin that referenced this pull request Apr 5, 2026
Add issues:[labeled] event trigger and claude label support so Claude
can work issues autonomously — reading the issue, creating a branch,
implementing the fix, and opening a PR.

Changes:
- Add issues:[labeled] trigger to on: block
- Add issue label condition to job if: guard
- Upgrade contents permission to write (needed for branch creation)
- Pin claude-code-action to v1.0.89 (6e2bd528)
- Add label_trigger: "claude" input
- Add dependabot skip condition on step
- Add permission comment for contents: write

Matches the standard defined in petry-projects/.github#24.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
don-petry pushed a commit to petry-projects/markets that referenced this pull request Apr 5, 2026
Add issues:[labeled] event trigger and claude label support so Claude
can work issues autonomously — reading the issue, creating a branch,
implementing the fix, and opening a PR.

Matches the standard defined in petry-projects/.github#24.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
don-petry pushed a commit to petry-projects/TalkTerm that referenced this pull request Apr 5, 2026
Add issues:[labeled] event trigger and claude label support so Claude
can work issues autonomously — reading the issue, creating a branch,
implementing the fix, and opening a PR.

Matches the standard defined in petry-projects/.github#24.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
don-petry added a commit to petry-projects/google-app-scripts that referenced this pull request Apr 5, 2026
Add issues:[labeled] event trigger and claude label support so Claude
can work issues autonomously — reading the issue, creating a branch,
implementing the fix, and opening a PR.

Changes:
- Add issues:[labeled] trigger to on: block
- Add issue label condition to job if: guard
- Upgrade contents permission to write (needed for branch creation)
- Pin claude-code-action to v1.0.89 (6e2bd528)
- Add label_trigger: "claude" input
- Add dependabot skip condition on step
- Add permission comment for contents: write

Matches the standard defined in petry-projects/.github#24.

Co-authored-by: DJ <dj@Rachels-MacBook-Air.local>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
don-petry added a commit to petry-projects/ContentTwin that referenced this pull request Apr 5, 2026
Add issues:[labeled] event trigger and claude label support so Claude
can work issues autonomously — reading the issue, creating a branch,
implementing the fix, and opening a PR.

Changes:
- Add issues:[labeled] trigger to on: block
- Add issue label condition to job if: guard
- Upgrade contents permission to write (needed for branch creation)
- Pin claude-code-action to v1.0.89 (6e2bd528)
- Add label_trigger: "claude" input
- Add dependabot skip condition on step
- Add permission comment for contents: write

Matches the standard defined in petry-projects/.github#24.

Co-authored-by: DJ <dj@Rachels-MacBook-Air.local>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
don-petry added a commit to petry-projects/TalkTerm that referenced this pull request Apr 5, 2026
Add issues:[labeled] event trigger and claude label support so Claude
can work issues autonomously — reading the issue, creating a branch,
implementing the fix, and opening a PR.

Matches the standard defined in petry-projects/.github#24.

Co-authored-by: DJ <dj@Rachels-MacBook-Air.local>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
don-petry added a commit to petry-projects/markets that referenced this pull request Apr 5, 2026
Add issues:[labeled] event trigger and claude label support so Claude
can work issues autonomously — reading the issue, creating a branch,
implementing the fix, and opening a PR.

Matches the standard defined in petry-projects/.github#24.

Co-authored-by: DJ <dj@Rachels-MacBook-Air.local>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
don-petry pushed a commit to petry-projects/bmad-bgreat-suite that referenced this pull request Apr 5, 2026
Add claude.yml with issue label trigger, PR review, and @claude mention
support. Includes actions/checkout for issue-triggered branch setup.

Implements the standard defined in petry-projects/.github#24.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
don-petry added a commit to petry-projects/bmad-bgreat-suite that referenced this pull request Apr 5, 2026
Add claude.yml with issue label trigger, PR review, and @claude mention
support. Includes actions/checkout for issue-triggered branch setup.

Implements the standard defined in petry-projects/.github#24.

Co-authored-by: DJ <dj@Rachels-MacBook-Air.local>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants