Skip to content

Set up markdownlint as GitHub Action for automated linting #58

@gwtaylor

Description

@gwtaylor

Summary

Add automated markdownlint checking via GitHub Actions to ensure consistent Markdown formatting across all PRs.

Background

This suggestion came from @egrace479's review of PR #56 (see comment) where she noted that manual linting could be automated.

Proposed Implementation

  • Add a GitHub Action workflow that runs markdownlint on all Markdown files
  • Use the existing .markdownlint.json configuration
  • Run on pull requests and pushes to main/dev branches
  • Consider using markdownlint-cli2 for better performance and configuration support

Benefits

Acceptance Criteria

  • GitHub Action workflow file created
  • Workflow runs markdownlint on PR creation and updates
  • Uses project's .markdownlint.json configuration
  • Provides clear error messages for contributors
  • Documents the automation in CONTRIBUTING.md

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions