Skip to content

Conversation

@ahouseholder
Copy link
Contributor

@ahouseholder ahouseholder commented Feb 19, 2025

This PR adds a markdownlint configuration and workflow to enforce consistent markdown style.

It touches a lot of files because it also brings our existing markdown into compliance with the linter as configured.

CoPilot Summary

This pull request includes several updates to Markdown linting workflows, configuration, and various Markdown files to improve consistency and readability. The most important changes include the addition of a GitHub Actions workflow for linting Markdown files, updates to the Markdown linting configuration, and numerous formatting adjustments across multiple Markdown files.

Workflow and Configuration Updates:

  • Added a new GitHub Actions workflow for linting Markdown files on push and pull request events in .github/workflows/lint_md_changes.yml.
  • Updated .markdownlint.yml configuration to disable certain noisy rules and enforce specific styles for unordered lists and emphasis.

Formatting Adjustments:

  • Replaced underscores with asterisks for emphasis in README.md, docs/_includes/helping_out.md, and docs/about/changelog.md to align with the updated linting rules. [1] [2] [3]
  • Changed plain URLs to angle-bracketed URLs in README.md for better Markdown compliance. [1] [2] [3]
  • Removed unnecessary blank lines in various Markdown files to improve readability and comply with linting rules. [1] [2] [3] [4]

These changes enhance the project's Markdown documentation quality and ensure consistency across the repository.

@ahouseholder ahouseholder self-assigned this Feb 19, 2025
@ahouseholder ahouseholder added content/semantic Changes to the semantic content of the SSVC documentation tech/environment Project environment, deployment, CI, etc. labels Feb 19, 2025
@ahouseholder ahouseholder added this to the 1Q25 milestone Feb 19, 2025
@ahouseholder ahouseholder marked this pull request as ready for review February 19, 2025 16:02
Copy link
Contributor

@sei-vsarvepalli sei-vsarvepalli left a comment

Choose a reason for hiding this comment

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

Annoying all the space related things in markdown that matter. it is good to keep this tight for programmatic workflows.

@ahouseholder ahouseholder merged commit 42afa91 into main Feb 19, 2025
5 checks passed
@ahouseholder ahouseholder deleted the feature/mdlint branch February 19, 2025 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content/semantic Changes to the semantic content of the SSVC documentation tech/environment Project environment, deployment, CI, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enforce markdown style with a linter workflow

3 participants